WARPXM v1.10.0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
TimestepConstraint Class Reference

Information that constrain the time step. More...

#include <timestep_constraint.h>

Detailed Description

Information that constrain the time step.

e.g. dt, x, and physics.

Public Member Functions

 TimestepConstraint ()
 
 TimestepConstraint (real dt, std::shared_ptr< std::string > physics)
 
 TimestepConstraint (real dt, std::array< real, 3 > x, std::shared_ptr< std::string > physics)
 
void setDt (const real dt)
 
real getDt () const
 
const std::array< real, 3 > & getX () const
 
const std::shared_ptr< std::string > & getPhysics () const
 
std::string str () const
 

Static Public Member Functions

static const TimestepConstraint & minDt (const TimestepConstraint &a, const TimestepConstraint &b)
 

Constructor & Destructor Documentation

◆ TimestepConstraint() [1/3]

TimestepConstraint::TimestepConstraint ( )
inline

◆ TimestepConstraint() [2/3]

TimestepConstraint::TimestepConstraint ( real  dt,
std::shared_ptr< std::string >  physics 
)
inline

◆ TimestepConstraint() [3/3]

TimestepConstraint::TimestepConstraint ( real  dt,
std::array< real, 3 >  x,
std::shared_ptr< std::string >  physics 
)
inline

Member Function Documentation

◆ getDt()

real TimestepConstraint::getDt ( ) const
inline

◆ getPhysics()

const std::shared_ptr< std::string > & TimestepConstraint::getPhysics ( ) const
inline

◆ getX()

const std::array< real, 3 > & TimestepConstraint::getX ( ) const
inline

◆ minDt()

static const TimestepConstraint & TimestepConstraint::minDt ( const TimestepConstraint &  a,
const TimestepConstraint &  b 
)
inlinestatic

◆ setDt()

void TimestepConstraint::setDt ( const real  dt)
inline

◆ str()

std::string TimestepConstraint::str ( ) const
The documentation for this class was generated from the following file: