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

#include <Objects.h>

Inheritance diagram for ObjectUnification:
Object

Public Member Functions

 ObjectUnification (std::shared_ptr< Object > obj1, std::shared_ptr< Object > obj2)
 
void readXML (XMLfileUnits &xmlconfig)
 Read in XML configuration for ObjectUnification 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

Abstract class to unify two objects

Constructor & Destructor Documentation

◆ ObjectUnification()

ObjectUnification::ObjectUnification ( std::shared_ptr< Object obj1,
std::shared_ptr< Object obj2 
)
inline

Constructor

Parameters
[in]obj1First object.
[in]obj2Second object.

Member Function Documentation

◆ getBboxMax()

void ObjectUnification::getBboxMax ( double  rmax[3])
inlinevirtual

Get upper corner of a bounding box around the object

Implements Object.

◆ getBboxMin()

void ObjectUnification::getBboxMin ( double  rmin[3])
inlinevirtual

Get lower corner of a bounding box around the object

Implements Object.

◆ getName()

std::string ObjectUnification::getName ( )
inlinevirtual

Get name of object

Implements Object.

◆ isInside()

bool ObjectUnification::isInside ( double  r[3])
inlinevirtual

Determines if the given point is inside the object

Implements Object.

◆ isInsideNoBorder()

bool ObjectUnification::isInsideNoBorder ( double  r[3])
inlinevirtual

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

Implements Object.

◆ readXML()

void ObjectUnification::readXML ( XMLfileUnits xmlconfig)
virtual

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

The following xml object structure is handled by this method:

<object>
<object1 type="..."> <!-- ... --> </object1>
<object2 type="..."> <!-- ... --> </object2>
</object>

Reimplemented from Object.


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