Tissue Forge C++ 0.2.1
Interactive, particle-based physics, chemistry and biology modeling and simulation environment
Loading...
Searching...
No Matches
TissueForge::Gaussian Struct Reference

Random force. More...

#include <tfForce.h>

Inheritance diagram for TissueForge::Gaussian:
Collaboration diagram for TissueForge::Gaussian:

Static Public Member Functions

static GaussianfromForce (Force *f)
 Convert basic force to Gaussian.
 
- Static Public Member Functions inherited from TissueForge::Force
static Berendsenberendsen_tstat (const FPTYPE &tau)
 Creates a Berendsen thermostat.
 
static Gaussianrandom (const FPTYPE &std, const FPTYPE &mean, const FPTYPE &duration=0.01)
 Creates a random force.
 
static Frictionfriction (const FPTYPE &coef)
 Creates a friction force.
 
static ForcefromString (const std::string &str)
 Create from a JSON string representation.
 

Public Attributes

FPTYPE std
 standard deviation of magnitude
 
FPTYPE mean
 mean of magnitude
 
unsigned durration_steps
 duration of force.
 
- Public Attributes inherited from TissueForge::Force
FORCE_TYPE type = FORCE_FORCE
 
Force_EvalFcn func
 
int stateVectorIndex = -1
 

Additional Inherited Members

- Public Member Functions inherited from TissueForge::Force
virtual bool isCustom ()
 Tests whether this object is a custom force type.
 
HRESULT bind_species (struct ParticleType *a_type, const std::string &coupling_symbol)
 Bind a force to a species.
 
Forceoperator+ (const Force &rhs)
 
virtual std::string toString ()
 Get a JSON string representation.
 

Detailed Description

Random force.

Create one with :meth:Force.random.

Member Function Documentation

◆ fromForce()

static Gaussian * TissueForge::Gaussian::fromForce ( Force * f)
static

Convert basic force to Gaussian.

If the basic force is not a Gaussian, then NULL is returned.

Parameters
f
Returns
Gaussian*

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