Torus.h

Go to the documentation of this file.

/*
 * University of Illinois Open Source License
 * Copyright 2011-2018 Luthey-Schulten Group,
 * All rights reserved.
 *
 * Developed by: Luthey-Schulten Group
 *               University of Illinois at Urbana-Champaign
 *               http://www.scs.uiuc.edu/~schulten
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the Software), to deal with
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is furnished to
 * do so, subject to the following conditions:
 *
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimers.
 *
 * - Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimers in the documentation
 * and/or other materials provided with the distribution.
 *
 * - Neither the names of the Luthey-Schulten Group, University of Illinois at
 * Urbana-Champaign, nor the names of its contributors may be used to endorse or
 * promote products derived from this Software without specific prior written
 * permission.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS WITH THE SOFTWARE.
 *
 * Author(s): Joseph R. Peterson
 */
 
#ifndef LM_BUILDER_TORUS_H_
#define LM_BUILDER_TORUS_H_
 
#include "builder/Shape.h"
#include "rdme/Lattice.h"
 
namespace lm {
    namespace builder {
        
        class Torus : public Shape
        {
        public:
            Torus(point center, si_dist_t r1, si_dist_t r2, site_t type, vector orientation = vector(0.0,0.0,1.0), vector up = vector(0.0,1.0,0.0));
            virtual ~Torus();
            
            virtual bool intersects(Shape * query);
            virtual bool contains(point query);
            virtual bool contains(Shape * query);
            virtual void setCenter(point center);
            virtual point getCenter() {return center;}
            virtual si_dist_t getRadius1() {return radius1;}
            virtual si_dist_t getRadius2() {return radius2;}
            virtual double getVolume();
            
        protected:
            point center;
            si_dist_t radius1; // big radius
            si_dist_t radius2; // small radius
            
        };
        
    }
}
 
#endif