hemocell
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | List of all members
hemo::HemoCellStretch Class Reference

Stretch a single cell by pulling vertices at both ends along x, as in an optical-tweezers experiment. More...

#include <hemoCellStretch.h>

Collaboration diagram for hemo::HemoCellStretch:
Collaboration graph
[legend]

Classes

class  FindForcedLsps
 
class  ForceForcedLsps
 

Public Member Functions

 HemoCellStretch (HemoCellField &cellfield_, unsigned int n_forced_lsps_, T external_force_)
 Select the vertices to pull.
 
void applyForce ()
 

Public Attributes

std::vector< plint > lower_lsps
 Vertex IDs of the vertices pulled towards -x (lower) and +x (upper).
 
std::vector< plint > upper_lsps
 
HemoCellField & cellfield
 
unsigned int n_forced_lsps
 
T external_force
 Force per pulled vertex [lattice force units].
 
T scale = 1.0
 Factor applied to the force at the next applyForce() calls (default 1).
 

Detailed Description

Stretch a single cell by pulling vertices at both ends along x, as in an optical-tweezers experiment.

The data are per object, so several simulations (or stretches) in one process do not influence each other. The object must live as long as applyForce() is called.

Constructor & Destructor Documentation

◆ HemoCellStretch()

hemo::HemoCellStretch::HemoCellStretch ( HemoCellField &  cellfield_,
unsigned int  n_forced_lsps_,
T  external_force_ 
)

Select the vertices to pull.

Picks the n_forced_lsps_ vertices of the cell with the lowest and the highest x position. Synchronises the particle envelopes; all MPI ranks must call it.

Parameters
[in]cellfield_Cell type with exactly one cell (cell ID 0).
[in]n_forced_lsps_Number of vertices pulled at each end.
[in]external_force_Total force per end [lattice force units], divided equally over its vertices.

Member Function Documentation

◆ applyForce()

void hemo::HemoCellStretch::applyForce ( )

Add the pulling force (times scale) to the vertices; call after every iterate() (needs a material update interval of 1). All MPI ranks must call it.

Member Data Documentation

◆ cellfield

HemoCellField& hemo::HemoCellStretch::cellfield

◆ external_force

T hemo::HemoCellStretch::external_force

Force per pulled vertex [lattice force units].

◆ lower_lsps

std::vector<plint> hemo::HemoCellStretch::lower_lsps

Vertex IDs of the vertices pulled towards -x (lower) and +x (upper).

◆ n_forced_lsps

unsigned int hemo::HemoCellStretch::n_forced_lsps

◆ scale

T hemo::HemoCellStretch::scale = 1.0

Factor applied to the force at the next applyForce() calls (default 1).

◆ upper_lsps

std::vector<plint> hemo::HemoCellStretch::upper_lsps