Class ComputeForceClass#

Defined in File computeforceclass.hpp

Inheritance Relationships#

Derived Types#

public ComputeVertexBendingEnergy (Class ComputeVertexBendingEnergy)
public ComputeVertexBendingHelfrichEnergy (Class ComputeVertexBendingHelfrichEnergy)
public ComputeVertexCauchyGreenEnergy (Class ComputeVertexCauchyGreenEnergy)
public ComputeVertexConstantAreaTriangleEnergy (Class ComputeVertexConstantAreaTriangleEnergy)
public ComputeVertexDihedralEnergy (Class ComputeVertexDihedralEnergy)
public ComputeVertexFerromagneticEnergy (Class ComputeVertexFerromagneticEnergy)
public ComputeVertexHarmonicEnergy (Class ComputeVertexHarmonicEnergy)
public ComputeVertexHarmonicSpinEnergy (Class ComputeVertexHarmonicSpinEnergy)
public ComputeVertexLimitEnergy (Class ComputeVertexLimitEnergy)
public ComputeVertexLineTension (Class ComputeVertexLineTension)
public ComputeVertexSubstrateEnergy (Class ComputeVertexSubstrateEnergy)

Class Documentation#

class ComputeForceClass

ComputeForceClass abstract class for compute different potentials, forces and torques.

Subclassed by ComputeVertexBendingEnergy, ComputeVertexBendingHelfrichEnergy, ComputeVertexCauchyGreenEnergy, ComputeVertexConstantAreaTriangleEnergy, ComputeVertexDihedralEnergy, ComputeVertexHarmonicEnergy, ComputeVertexLimitEnergy, ComputeVertexLineTension, ComputeVertexSubstrateEnergy

Public Functions

inline ComputeForceClass(SystemClass &system)

ComputeForceClass constructor.

Parameters:: SystemClass – reference to the system

inline virtual ~ComputeForceClass(): ComputeForceClass Destructor.

inline virtual void compute_energy(void)

compute energy for the actual configuration

Parameters:: void –
Returns:: void

inline virtual void compute(void)

compute force for the actual configuration

Parameters:: void –
Returns:: void

inline virtual real compute_edge_energy(int)

compute the energy in a given edge

Parameters:: edge –
Returns:: real

inline virtual real compute_face_energy(int)

compute the energy in a given face

Parameters:: face –
Returns:: real

inline virtual real compute_vertex_energy(int)

compute the energy in a vertex edge

Parameters:: face –
Returns:: real

inline virtual void compute_stress(void)

compute force for the actual configuration

Parameters:: void –
Returns:: void

inline virtual void compute_atomic_stress(void)

compute force for the actual configuration

Parameters:: void –
Returns:: void

inline std::string get_name(void)

Get the name object.

Returns:: std::string

inline std::string get_type(void)

Get the type object.

Returns:: std::string

virtual std::map<std::string, std::string> get_info(void) = 0

Get the type object.

Returns:: std::string

virtual void set_default_properties(void) = 0: Set property.

inline virtual void set_property(std::map<std::string, std::map<std::pair<std::string, std::string>, std::string>> &region_map)

inline virtual void set_property(std::map<std::string, std::map<std::string, std::string>> &region_map)

inline virtual void set_property(std::map<std::string, std::string> &region_map)

inline void print_warning_calling(const std::string &message)

inline void print_warning_property_name(const std::string &message)

Protected Attributes

SystemClass &_system: Reference to the system.

std::string m_name: Name declared for that potential.

std::string m_type: Potential type, active, torque, conservative, etc.

int NUM_TYPES_ALLOWED

int NUM_TYPES_PAIR