opynsim
Unofficial C++ Documentation
Loading...
Searching...
No Matches
Public Member Functions | List of all members
opyn::ForwardDynamicsSolver Class Referencefinal

#include <forward_dynamics_solver.h>

Public Member Functions

 ForwardDynamicsSolver (Model model, ModelState model_state, const std::optional< IntegratorSettings > &=std::nullopt)
 
 ForwardDynamicsSolver (const ForwardDynamicsSolver &)=delete
 
 ForwardDynamicsSolver (ForwardDynamicsSolver &&) noexcept
 
 ~ForwardDynamicsSolver () noexcept
 
ForwardDynamicsSolveroperator= (const ForwardDynamicsSolver &)=delete
 
ForwardDynamicsSolveroperator= (ForwardDynamicsSolver &&) noexcept
 
ModelState integrate_to (double time, ModelStateStage realized_to=ModelStateStage::report)
 

Detailed Description

Integrates the forward dynamics of a model + state pair.

The solver stores a ModelState that it integrates forward in time to a caller-specified timepoint (see integrate_to).

Constructor & Destructor Documentation

◆ ForwardDynamicsSolver() [1/3]

opyn::ForwardDynamicsSolver::ForwardDynamicsSolver ( Model  model,
ModelState  model_state,
const std::optional< IntegratorSettings > &  = std::nullopt 
)
explicit

Constructs a ForwardDynamicsSolver that starts with the given model and model_state pair and uses an integrator configured with integrator_settings (if provided).

◆ ForwardDynamicsSolver() [2/3]

opyn::ForwardDynamicsSolver::ForwardDynamicsSolver ( const ForwardDynamicsSolver )
delete

◆ ForwardDynamicsSolver() [3/3]

opyn::ForwardDynamicsSolver::ForwardDynamicsSolver ( ForwardDynamicsSolver &&  )
noexcept

◆ ~ForwardDynamicsSolver()

opyn::ForwardDynamicsSolver::~ForwardDynamicsSolver ( )
noexcept

Member Function Documentation

◆ integrate_to()

ModelState opyn::ForwardDynamicsSolver::integrate_to ( double  time,
ModelStateStage  realized_to = ModelStateStage::report 
)

Solves the forward dynamics of the internal ModelState to time and returns a copy of it realized to at least realized_to.

◆ operator=() [1/2]

ForwardDynamicsSolver & opyn::ForwardDynamicsSolver::operator= ( const ForwardDynamicsSolver )
delete

◆ operator=() [2/2]

ForwardDynamicsSolver & opyn::ForwardDynamicsSolver::operator= ( ForwardDynamicsSolver &&  )
noexcept

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