MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
CGPoint< Coordinates, Fields > Class Template Reference

Combines the position of the CGPoint (e.g. x, y, z), the parameters of the coarse-graining function (e.g. width and cutoff) and the fields to be evaluated (e.g., density, momentum, stress). More...

#include <CGPoint.h>

+ Inheritance diagram for CGPoint< Coordinates, Fields >:

Public Types

typedef Coordinates CoordinatesType
 

Public Member Functions

 CGPoint ()=default
 
 CGPoint (const CGPoint &orig)=default
 
virtual ~CGPoint ()=default
 
void write (std::ostream &os) const
 Combines the write functions of the two base classes Coordinates and Fields. More...
 

Public Attributes

Coordinates coordinates
 

Detailed Description

template<class Coordinates, class Fields = CGFields::StandardFields>
class CGPoint< Coordinates, Fields >

Combines the position of the CGPoint (e.g. x, y, z), the parameters of the coarse-graining function (e.g. width and cutoff) and the fields to be evaluated (e.g., density, momentum, stress).

The class is combines the properties of a StandardFields and a CGFunctions class. It contains two functions that depend on both the fields and the cg function, evaluateParticle and evaluateContact.

See StandardFields and CGFunctions for more details.

Definition at line 43 of file CGPoint.h.

Member Typedef Documentation

template<class Coordinates , class Fields = CGFields::StandardFields>
typedef Coordinates CGPoint< Coordinates, Fields >::CoordinatesType

Definition at line 47 of file CGPoint.h.

Constructor & Destructor Documentation

template<class Coordinates , class Fields = CGFields::StandardFields>
CGPoint< Coordinates, Fields >::CGPoint ( )
default
template<class Coordinates , class Fields = CGFields::StandardFields>
CGPoint< Coordinates, Fields >::CGPoint ( const CGPoint< Coordinates, Fields > &  orig)
default
template<class Coordinates , class Fields = CGFields::StandardFields>
virtual CGPoint< Coordinates, Fields >::~CGPoint ( )
virtualdefault

Member Function Documentation

template<class Coordinates , class Fields = CGFields::StandardFields>
void CGPoint< Coordinates, Fields >::write ( std::ostream &  os) const
inline

Combines the write functions of the two base classes Coordinates and Fields.

Definition at line 58 of file CGPoint.h.

References CGPoint< Coordinates, Fields >::coordinates.

59  {
60  coordinates.write(os);
61  Fields::write(os);
62  }
Coordinates coordinates
Definition: CGPoint.h:66

Member Data Documentation

template<class Coordinates , class Fields = CGFields::StandardFields>
Coordinates CGPoint< Coordinates, Fields >::coordinates

Definition at line 66 of file CGPoint.h.

Referenced by CGPoint< Coordinates, Fields >::write().


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