Class ComputeVertexLineTension

• Defined in File potentialLineTension.hpp

Inheritance Relationships

Base Type

• public ComputeForceClass (Class ComputeForceClass)

Class Documentation

class ComputeVertexLineTension : public ComputeForceClass

Implements the line tension contribution to the edge energy.

This is the most basic form of the line tension energy. The line tension energy ( E ) associated with a vertex is given by:

\[ E = \sum_{\text{neighboring edges}} \gamma_{\text{type}} \times s \]

Where:

• (\gamma_{\text{type}}) is determined by:

  • Averaging the (\gamma) values of the two vertices forming the edge if \texttt{flag_avg} is true:

    \[ \gamma_{\text{type}} = 0.5 \times (\gamma[\text{type\_0}] + \gamma[\text{type\_1}]) \]

  • Taking the (\gamma) value of the query vertex if \texttt{flag_avg} is false: (\gamma_{\text{type}} = \gamma[\text{type_0}])

• (s) is either:

  • The Euclidean distance between the two vertices if \texttt{flag_scale} is true:

    \[ s = ||\textbf{r}_{\text{query\_vertex}} - \textbf{r}_{\text{neighboring\_vertex}}|| \]

  • 1.0 if \texttt{flag_scale} is false.

Public Functions

inline ComputeVertexLineTension(SystemClass &system)

inline ~ComputeVertexLineTension()

inline virtual void set_default_properties(void) override

Set property.

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

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

inline virtual std::map<std::string, std::string> get_info(void) override

Get the type object.

Returns:

std::string

virtual void compute_energy(void) override

compute energy for the actual configuration

Parameters:

void –

Returns:

void

virtual real compute_edge_energy(int) override

compute the energy in a given edge

Parameters:

edge –

Returns:

real

virtual real compute_vertex_energy(int) override

compute the energy in a vertex edge

Parameters:

face –

Returns:

real

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

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

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