ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
IBMVolCons Struct Reference

Parameters for IBM volume conservation bond. More...

#include <ibm_volcons.hpp>

Public Member Functions

double cutoff () const
 
 IBMVolCons (int softID, double kappaV)
 
double get_current_volume () const
 
void set_volumes_view (std::vector< double > const &volumes)
 
void unset_volumes_view ()
 

Public Attributes

unsigned int softID
 ID of the large soft particle to which this node belongs.
 
double volRef
 Reference volume.
 
double kappaV
 Spring constant for volume force.
 

Static Public Attributes

static constexpr int num = 0
 

Detailed Description

Parameters for IBM volume conservation bond.

Definition at line 29 of file ibm_volcons.hpp.

Constructor & Destructor Documentation

◆ IBMVolCons()

IBMVolCons::IBMVolCons ( int  softID,
double  kappaV 
)
inline

Definition at line 41 of file ibm_volcons.hpp.

References kappaV, softID, and volRef.

Member Function Documentation

◆ cutoff()

double IBMVolCons::cutoff ( ) const
inline

Definition at line 37 of file ibm_volcons.hpp.

◆ get_current_volume()

double IBMVolCons::get_current_volume ( ) const
inline

Definition at line 55 of file ibm_volcons.hpp.

References softID.

◆ set_volumes_view()

void IBMVolCons::set_volumes_view ( std::vector< double > const &  volumes)
inline

Definition at line 64 of file ibm_volcons.hpp.

Referenced by ImmersedBoundaries::register_softID().

◆ unset_volumes_view()

void IBMVolCons::unset_volumes_view ( )
inline

Definition at line 67 of file ibm_volcons.hpp.

Member Data Documentation

◆ kappaV

double IBMVolCons::kappaV

Spring constant for volume force.

Definition at line 35 of file ibm_volcons.hpp.

Referenced by IBMVolCons().

◆ num

constexpr int IBMVolCons::num = 0
staticconstexpr

Definition at line 39 of file ibm_volcons.hpp.

◆ softID

unsigned int IBMVolCons::softID

ID of the large soft particle to which this node belongs.

Definition at line 31 of file ibm_volcons.hpp.

Referenced by get_current_volume(), IBMVolCons(), and ImmersedBoundaries::register_softID().

◆ volRef

double IBMVolCons::volRef

Reference volume.

Definition at line 33 of file ibm_volcons.hpp.

Referenced by IBMVolCons().


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