ls1-MarDyn
ls1-MarDyn molecular dynamics code
Public Member Functions | Static Public Member Functions | List of all members
Sphere Class Reference

#include <Objects.h>

Inheritance diagram for Sphere:
Object

Public Member Functions

 Sphere ()
 
 Sphere (double center[3], double r)
 
void readXML (XMLfileUnits &xmlconfig)
 Read in XML configuration for Sphere and all its included objects. More...
 
std::string getName ()
 
bool isInside (double r[3])
 
bool isInsideNoBorder (double r[3])
 
void getBboxMin (double rmin[3])
 
void getBboxMax (double rmax[3])
 
- Public Member Functions inherited from Object
virtual std::string getPluginName () final
 

Static Public Member Functions

static ObjectcreateInstance ()
 

Detailed Description

Class implementing a sphere

Constructor & Destructor Documentation

◆ Sphere()

Sphere::Sphere ( )

Class implementing a sphere

Member Function Documentation

◆ getBboxMax()

void Sphere::getBboxMax ( double  rmax[3])
virtual

Get upper corner of a bounding box around the object

Implements Object.

◆ getBboxMin()

void Sphere::getBboxMin ( double  rmin[3])
virtual

Get lower corner of a bounding box around the object

Implements Object.

◆ getName()

std::string Sphere::getName ( )
inlinevirtual

Get name of object

Implements Object.

◆ isInside()

bool Sphere::isInside ( double  r[3])
virtual

Determines if the given point is inside the object

Implements Object.

◆ isInsideNoBorder()

bool Sphere::isInsideNoBorder ( double  r[3])
virtual

Determines if the given point is inside the object excluding it's border

Implements Object.

◆ readXML()

void Sphere::readXML ( XMLfileUnits xmlconfig)
virtual

Read in XML configuration for Sphere and all its included objects.

The following xml object structure is handled by this method:

<object>
<center> <x>DOUBLE</x> <y>DOUBLE</y> <z>DOUBLE</z> </center>
<radius>DOUBLE</radius>
</object>

Reimplemented from Object.


The documentation for this class was generated from the following files: