Actors
- class tissue_forge.models.vertex.solver.Adhesion(_lam: FloatP_t const & = 0)
Models adhesion between pairs of ‘Surface’ or ‘Body’ instances by type.
Adhesion is implemented for two-dimensional objects as minimization of the Hamiltonian,
\[\lambda L\]Here \(\lambda\) is a parameter and \(L\) is the length of edges shared by two objects.
Adhesion is implemented for three-dimensional objects as minimization of the Hamiltonian,
\[\lambda A\]Here \(A\) is the area shared by two objects.
- property lam
Adhesion value. Higher values result in weaker adhesivity.
- energy(*args) FloatP_t
Overload 1:
Calculate the energy of a source object acting on a target object
Overload 2:
Calculate the energy of a source object acting on a target object
- force(*args) TissueForge::FVector3
Overload 1:
Calculate the force that a source object exerts on a target object
Overload 2:
Calculate the force that a source object exerts on a target object
- class tissue_forge.models.vertex.solver.BodyForce(*args, **kwargs)
Imposes a body force on
Bodyinstances- property comps
Force components
- energy(source: _vertex_solver_Body, target: _vertex_solver_Vertex) FloatP_t
Calculate the energy of a source object acting on a target object
- class tissue_forge.models.vertex.solver.EdgeTension(lam: FloatP_t const & = 0, order: unsigned int const & = 1)
Models tension between connected vertices.
Edge tension is implemented for two-dimensional objects as minimization of the Hamiltonian,
\[\lambda L^n\]Here \(\lambda\) is a parameter, \(L\) is the length of an edge shared by two objects and \(n > 0\) is the order of the model.
- property lam
Tension value
- property order
Order of distance measurement
- energy(source: _vertex_solver_Surface, target: _vertex_solver_Vertex) FloatP_t
Calculate the energy of a source object acting on a target object
- class tissue_forge.models.vertex.solver.NormalStress(_mag: FloatP_t const & = 0)
Models a stress acting on a
Surfacealong its normal- property mag
Magnitude
- energy(source: _vertex_solver_Surface, target: _vertex_solver_Vertex) FloatP_t
Calculate the energy of a source object acting on a target object
- class tissue_forge.models.vertex.solver.PerimeterConstraint(_lam: FloatP_t const & = 0, _constr: FloatP_t const & = 0)
Imposes a perimeter constraint on ‘Surface’ instances.
The perimeter constraint is implemented for two-dimensional objects as minimization of the Hamiltonian,
\[\lambda \left( L - L_o \]ight)^2
Here \(\lambda\) is a parameter, \(L\) is the perimeter of an object and \(L_o\) is a target perimeter.
- property lam
Constraint value
- property constr
Target perimeter
- energy(source: _vertex_solver_Surface, target: _vertex_solver_Vertex) FloatP_t
Calculate the energy of a source object acting on a target object
- class tissue_forge.models.vertex.solver.SurfaceAreaConstraint(_lam: FloatP_t const & = 0, _constr: FloatP_t const & = 0)
Imposes a surface area constraint on ‘Body’ or ‘Surface’ instances.
The surface area constraint is implemented for two- and three-dimensional objects as minimization of the Hamiltonian,
\[\lambda \left( A - A_o \]ight)^2
Here \(\lambda\) is a parameter, \(A\) is the area an object and \(A_o\) is a target area.
- property lam
Constraint value
- property constr
Target area
- energy(*args) FloatP_t
Overload 1:
Calculate the energy of a source object acting on a target object
Overload 2:
Calculate the energy of a source object acting on a target object
- force(*args) TissueForge::FVector3
Overload 1:
Calculate the force that a source object exerts on a target object
Overload 2:
Calculate the force that a source object exerts on a target object
- class tissue_forge.models.vertex.solver.SurfaceTraction(*args, **kwargs)
Models a traction force
- property comps
Force components
- energy(source: _vertex_solver_Surface, target: _vertex_solver_Vertex) FloatP_t
Calculate the energy of a source object acting on a target object
- class tissue_forge.models.vertex.solver.VolumeConstraint(_lam: FloatP_t const & = 0, _constr: FloatP_t const & = 0)
Imposes a volume constraint.
The volume constraint is implemented for three-dimensional objects as minimization of the Hamiltonian,
\[\lambda \left( V - V_o \]ight)^2
Here \(\lambda\) is a parameter, \(V\) is the volume an object and \(V_o\) is a target volume.
- property lam
Constraint value
- property constr
Target volume
- energy(source: _vertex_solver_Body, target: _vertex_solver_Vertex) FloatP_t
Calculate the energy of a source object acting on a target object