PolyFEM
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
polyfem::time_integrator::ImplicitTimeIntegrator Class Referenceabstract

Implicit time integrator of a second order ODE (equivently a system of coupled first order ODEs). More...

#include <ImplicitTimeIntegrator.hpp>

Inheritance diagram for polyfem::time_integrator::ImplicitTimeIntegrator:
[legend]

Public Types

enum class  DynamicOrder { First , Second }
 

Public Member Functions

 ImplicitTimeIntegrator (const DynamicOrder dynamic_order)
 
virtual ~ImplicitTimeIntegrator ()=default
 
virtual void set_parameters (const json &params)
 Set the time integrator parameters from a json object.
 
virtual void init (const Eigen::MatrixXd &x_prevs, const Eigen::MatrixXd &v_prevs, const Eigen::MatrixXd &a_prevs, double dt)
 Initialize the time integrator with the previous values for \(x\), \(v\), and \(a\).
 
virtual void update_quantities (const Eigen::VectorXd &x)=0
 Update the time integration quantities (i.e., \(x\), \(v\), and \(a\)).
 
virtual Eigen::VectorXd x_tilde () const =0
 Compute the predicted solution to be used in the inertia term \((x-\tilde{x})^TM(x-\tilde{x})\).
 
virtual Eigen::VectorXd compute_velocity (const Eigen::VectorXd &x) const =0
 Compute the current velocity given the current solution and using the stored previous solution(s).
 
virtual Eigen::VectorXd compute_acceleration (const Eigen::VectorXd &v) const =0
 Compute the current acceleration given the current velocity and using the stored previous velocity(s).
 
virtual double acceleration_scaling () const =0
 Compute the acceleration scaling used to scale forces when integrating a second order ODE.
 
virtual double dv_dx (const unsigned prev_ti=0) const =0
 Compute the derivative of the velocity with respect to the solution.
 
const double & dt () const
 Access the time step size.
 
virtual void save_state (const std::string &state_path) const
 Save the values of \(x\), \(v\), and \(a\).
 
const Eigen::VectorXd & x_prev () const
 Get the most recent previous solution value.
 
const Eigen::VectorXd & v_prev () const
 Get the most recent previous velocity value.
 
const Eigen::VectorXd & a_prev () const
 Get the most recent previous acceleration value.
 
const std::deque< Eigen::VectorXd > & x_prevs () const
 Get the (relevant) history of previous solution value.
 
const std::deque< Eigen::VectorXd > & v_prevs () const
 Get the (relevant) history of previous velocity value.
 
const std::deque< Eigen::VectorXd > & a_prevs () const
 Get the (relevant) history of previous acceleration value.
 
int steps () const
 Get the current number of steps to use for integration.
 

Static Public Member Functions

static std::shared_ptr< ImplicitTimeIntegrator > construct_time_integrator (const json &params, DynamicOrder dynamic_order=DynamicOrder::Second)
 Factory method for constructing an implicit time integrator.
 
static std::shared_ptr< BDF > construct_bdf_integrator (const json &params, DynamicOrder dynamic_order=DynamicOrder::Second)
 Construct a BDF integrator for algorithms using BDF-specific operations.
 
static const std::vector< std::string > & get_time_integrator_names ()
 Get a vector of the names of possible ImplicitTimeIntegrators.
 

Protected Member Functions

virtual int max_steps () const
 Get the maximum number of steps to use for integration.
 
void set_x_prev (const Eigen::VectorXd &x_prev)
 Convenience functions for setting the most recent previous solution.
 
void set_v_prev (const Eigen::VectorXd &v_prev)
 Convenience functions for setting the most recent previous velocity.
 
void set_a_prev (const Eigen::VectorXd &a_prev)
 Convenience functions for setting the most recent previous acceleration.
 

Protected Attributes

const DynamicOrder dynamic_order_
 
double dt_ = 1
 Time step size.
 
std::deque< Eigen::VectorXd > x_prevs_
 Store the necessary previous values of the solution for single or multi-step integration.
 
std::deque< Eigen::VectorXd > v_prevs_
 Store the necessary previous values of the velocity for single or multi-step integration.
 
std::deque< Eigen::VectorXd > a_prevs_
 Store the necessary previous values of the acceleration for single or multi-step integration.
 

Detailed Description

Implicit time integrator of a second order ODE (equivently a system of coupled first order ODEs).

Definition at line 16 of file ImplicitTimeIntegrator.hpp.

Member Enumeration Documentation

◆ DynamicOrder

enum class polyfem::time_integrator::ImplicitTimeIntegrator::DynamicOrder
strong
Enumerator
First 
Second 

Definition at line 19 of file ImplicitTimeIntegrator.hpp.

Constructor & Destructor Documentation

◆ ImplicitTimeIntegrator()

polyfem::time_integrator::ImplicitTimeIntegrator::ImplicitTimeIntegrator ( const DynamicOrder  dynamic_order)
inline

Definition at line 25 of file ImplicitTimeIntegrator.hpp.

◆ ~ImplicitTimeIntegrator()

virtual polyfem::time_integrator::ImplicitTimeIntegrator::~ImplicitTimeIntegrator ( )
virtualdefault

Member Function Documentation

◆ a_prev()

const Eigen::VectorXd & polyfem::time_integrator::ImplicitTimeIntegrator::a_prev ( ) const
inline

Get the most recent previous acceleration value.

Definition at line 99 of file ImplicitTimeIntegrator.hpp.

References a_prevs_.

Referenced by polyfem::time_integrator::ImplicitNewmark::compute_acceleration(), polyfem::time_integrator::ImplicitNewmark::compute_velocity(), set_a_prev(), and polyfem::time_integrator::ImplicitNewmark::x_tilde().

Here is the caller graph for this function:

◆ a_prevs()

const std::deque< Eigen::VectorXd > & polyfem::time_integrator::ImplicitTimeIntegrator::a_prevs ( ) const
inline

Get the (relevant) history of previous acceleration value.

Definition at line 106 of file ImplicitTimeIntegrator.hpp.

References a_prevs_.

Referenced by init(), and save_state().

Here is the caller graph for this function:

◆ acceleration_scaling()

virtual double polyfem::time_integrator::ImplicitTimeIntegrator::acceleration_scaling ( ) const
pure virtual

Compute the acceleration scaling used to scale forces when integrating a second order ODE.

Returns
value of the acceleration scaling

Implemented in polyfem::time_integrator::BDF, polyfem::time_integrator::ImplicitEuler, and polyfem::time_integrator::ImplicitNewmark.

◆ compute_acceleration()

virtual Eigen::VectorXd polyfem::time_integrator::ImplicitTimeIntegrator::compute_acceleration ( const Eigen::VectorXd &  v) const
pure virtual

Compute the current acceleration given the current velocity and using the stored previous velocity(s).

Parameters
vcurrent velocity
Returns
value for \(a\)

Implemented in polyfem::time_integrator::BDF, polyfem::time_integrator::ImplicitEuler, and polyfem::time_integrator::ImplicitNewmark.

◆ compute_velocity()

virtual Eigen::VectorXd polyfem::time_integrator::ImplicitTimeIntegrator::compute_velocity ( const Eigen::VectorXd &  x) const
pure virtual

Compute the current velocity given the current solution and using the stored previous solution(s).

Parameters
xcurrent solution
Returns
value for \(v\)

Implemented in polyfem::time_integrator::BDF, polyfem::time_integrator::ImplicitEuler, and polyfem::time_integrator::ImplicitNewmark.

Referenced by polyfem::solver::RayleighDampingForm::first_derivative_unweighted(), and polyfem::solver::RayleighDampingForm::value_unweighted().

Here is the caller graph for this function:

◆ construct_bdf_integrator()

std::shared_ptr< BDF > polyfem::time_integrator::ImplicitTimeIntegrator::construct_bdf_integrator ( const json &  params,
DynamicOrder  dynamic_order = DynamicOrder::Second 
)
static

Construct a BDF integrator for algorithms using BDF-specific operations.

ImplicitEuler is accepted as the one-step BDF scheme.

Parameters
paramsintegrator name or an object containing its type and parameters
dynamic_orderorder of the underlying dynamics

Definition at line 97 of file ImplicitTimeIntegrator.cpp.

References polyfem::log_and_throw_error(), and polyfem::utils::StringUtils::startswith().

Referenced by polyfem::varform::NavierStokesVarForm::solve_problem(), polyfem::varform::ScalarVarForm::solve_transient(), polyfem::varform::BilaplacianVarForm::solve_transient_linear(), polyfem::varform::StokesVarForm::solve_transient_linear(), and polyfem::varform::IncompressibleElasticVarForm::solve_transient_linear().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ construct_time_integrator()

std::shared_ptr< ImplicitTimeIntegrator > polyfem::time_integrator::ImplicitTimeIntegrator::construct_time_integrator ( const json &  params,
DynamicOrder  dynamic_order = DynamicOrder::Second 
)
static

Factory method for constructing an implicit time integrator.

Parameters
paramsintegrator name or an object containing its type and parameters
dynamic_orderorder of the underlying dynamics
Returns
new implicit time integrator of the specified type

Definition at line 66 of file ImplicitTimeIntegrator.cpp.

References polyfem::logger(), and polyfem::utils::StringUtils::startswith().

Referenced by polyfem::varform::ThermoElasticVarForm::build_forms(), polyfem::varform::LinearElasticVarForm::init_linear_solve(), polyfem::legacy::State::init_linear_solve(), polyfem::legacy::State::init_nonlinear_tensor_solve(), polyfem::mesh::LocalRelaxationData< M >::init_solve_data(), and polyfem::legacy::State::solve_transient_linear().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ dt()

const double & polyfem::time_integrator::ImplicitTimeIntegrator::dt ( ) const
inline

Access the time step size.

Definition at line 68 of file ImplicitTimeIntegrator.hpp.

References dt_.

Referenced by polyfem::time_integrator::BDF::acceleration_scaling(), polyfem::time_integrator::ImplicitEuler::acceleration_scaling(), polyfem::time_integrator::ImplicitNewmark::acceleration_scaling(), polyfem::time_integrator::BDF::beta_dt(), polyfem::time_integrator::ImplicitEuler::compute_acceleration(), polyfem::time_integrator::ImplicitNewmark::compute_acceleration(), polyfem::time_integrator::ImplicitEuler::compute_velocity(), polyfem::time_integrator::ImplicitNewmark::compute_velocity(), polyfem::time_integrator::ImplicitNewmark::da_dx(), polyfem::time_integrator::ImplicitEuler::dv_dx(), polyfem::time_integrator::ImplicitNewmark::dv_dx(), init(), polyfem::solver::RayleighDampingForm::stiffness(), polyfem::time_integrator::BDF::x_tilde(), polyfem::time_integrator::ImplicitEuler::x_tilde(), and polyfem::time_integrator::ImplicitNewmark::x_tilde().

Here is the caller graph for this function:

◆ dv_dx()

virtual double polyfem::time_integrator::ImplicitTimeIntegrator::dv_dx ( const unsigned  prev_ti = 0) const
pure virtual

Compute the derivative of the velocity with respect to the solution.

Parameters
prev_tiindex of the previous solution to use (0 -> current; 1 -> previous; 2 -> second previous; etc.)

Implemented in polyfem::time_integrator::BDF, polyfem::time_integrator::ImplicitEuler, and polyfem::time_integrator::ImplicitNewmark.

Referenced by polyfem::solver::RayleighDampingForm::second_derivative_unweighted(), and polyfem::solver::RayleighDampingForm::value_unweighted().

Here is the caller graph for this function:

◆ get_time_integrator_names()

const std::vector< std::string > & polyfem::time_integrator::ImplicitTimeIntegrator::get_time_integrator_names ( )
static

Get a vector of the names of possible ImplicitTimeIntegrators.

Returns
names in no particular order

Definition at line 120 of file ImplicitTimeIntegrator.cpp.

◆ init()

void polyfem::time_integrator::ImplicitTimeIntegrator::init ( const Eigen::MatrixXd &  x_prevs,
const Eigen::MatrixXd &  v_prevs,
const Eigen::MatrixXd &  a_prevs,
double  dt 
)
virtual

Initialize the time integrator with the previous values for \(x\), \(v\), and \(a\).

Parameters
x_prevprevious value(s) for the solution
v_prevprevious value(s) for the velocity
a_prevprevious value(s) for the acceleration
dttime step size
Note
Multiple previous values for x, v, and a can be provided as columns of the input matrices.

Definition at line 18 of file ImplicitTimeIntegrator.cpp.

References a_prevs(), a_prevs_, dt(), dt_, max_steps(), v_prevs(), v_prevs_, x_prevs(), and x_prevs_.

Here is the call graph for this function:

◆ max_steps()

virtual int polyfem::time_integrator::ImplicitTimeIntegrator::max_steps ( ) const
inlineprotectedvirtual

Get the maximum number of steps to use for integration.

Reimplemented in polyfem::time_integrator::BDF.

Definition at line 115 of file ImplicitTimeIntegrator.hpp.

Referenced by init().

Here is the caller graph for this function:

◆ save_state()

void polyfem::time_integrator::ImplicitTimeIntegrator::save_state ( const std::string &  state_path) const
virtual

Save the values of \(x\), \(v\), and \(a\).

Parameters
state_pathpath for the output file containing \(x, v, a\) as hdf5

Definition at line 44 of file ImplicitTimeIntegrator.cpp.

References a_prevs(), v_prevs(), polyfem::io::write_matrix(), x_prev(), and x_prevs().

Referenced by polyfem::varform::VarForm::save_step_state().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_a_prev()

void polyfem::time_integrator::ImplicitTimeIntegrator::set_a_prev ( const Eigen::VectorXd &  a_prev)
inlineprotected

Convenience functions for setting the most recent previous acceleration.

Definition at line 133 of file ImplicitTimeIntegrator.hpp.

References a_prev(), and a_prevs_.

Referenced by polyfem::time_integrator::ImplicitEuler::update_quantities(), and polyfem::time_integrator::ImplicitNewmark::update_quantities().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_parameters()

virtual void polyfem::time_integrator::ImplicitTimeIntegrator::set_parameters ( const json &  params)
inlinevirtual

Set the time integrator parameters from a json object.

Parameters
paramsjson containing parameters specific to each time integrator

Reimplemented in polyfem::time_integrator::BDF, and polyfem::time_integrator::ImplicitNewmark.

Definition at line 31 of file ImplicitTimeIntegrator.hpp.

◆ set_v_prev()

void polyfem::time_integrator::ImplicitTimeIntegrator::set_v_prev ( const Eigen::VectorXd &  v_prev)
inlineprotected

Convenience functions for setting the most recent previous velocity.

Definition at line 131 of file ImplicitTimeIntegrator.hpp.

References v_prev(), and v_prevs_.

Referenced by polyfem::time_integrator::ImplicitEuler::update_quantities(), and polyfem::time_integrator::ImplicitNewmark::update_quantities().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_x_prev()

void polyfem::time_integrator::ImplicitTimeIntegrator::set_x_prev ( const Eigen::VectorXd &  x_prev)
inlineprotected

Convenience functions for setting the most recent previous solution.

Definition at line 129 of file ImplicitTimeIntegrator.hpp.

References x_prev(), and x_prevs_.

Referenced by polyfem::time_integrator::ImplicitEuler::update_quantities(), and polyfem::time_integrator::ImplicitNewmark::update_quantities().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ steps()

int polyfem::time_integrator::ImplicitTimeIntegrator::steps ( ) const
inline

Get the current number of steps to use for integration.

Definition at line 109 of file ImplicitTimeIntegrator.hpp.

References x_prevs_.

Referenced by polyfem::time_integrator::BDF::acceleration_scaling(), polyfem::time_integrator::BDF::beta_dt(), polyfem::time_integrator::BDF::dv_dx(), polyfem::time_integrator::BDF::update_quantities(), polyfem::time_integrator::BDF::weighted_sum_v_prevs(), polyfem::time_integrator::BDF::weighted_sum_x_prevs(), and polyfem::time_integrator::BDF::x_tilde().

Here is the caller graph for this function:

◆ update_quantities()

virtual void polyfem::time_integrator::ImplicitTimeIntegrator::update_quantities ( const Eigen::VectorXd &  x)
pure virtual

Update the time integration quantities (i.e., \(x\), \(v\), and \(a\)).

Parameters
xnew solution vector

Implemented in polyfem::time_integrator::BDF, polyfem::time_integrator::ImplicitEuler, and polyfem::time_integrator::ImplicitNewmark.

◆ v_prev()

const Eigen::VectorXd & polyfem::time_integrator::ImplicitTimeIntegrator::v_prev ( ) const
inline

Get the most recent previous velocity value.

Definition at line 97 of file ImplicitTimeIntegrator.hpp.

References v_prevs_.

Referenced by polyfem::DiffCache::cache_transient(), polyfem::time_integrator::ImplicitEuler::compute_acceleration(), polyfem::time_integrator::ImplicitNewmark::compute_acceleration(), polyfem::time_integrator::ImplicitNewmark::compute_velocity(), set_v_prev(), polyfem::time_integrator::BDF::weighted_sum_v_prevs(), polyfem::time_integrator::ImplicitEuler::x_tilde(), and polyfem::time_integrator::ImplicitNewmark::x_tilde().

Here is the caller graph for this function:

◆ v_prevs()

const std::deque< Eigen::VectorXd > & polyfem::time_integrator::ImplicitTimeIntegrator::v_prevs ( ) const
inline

Get the (relevant) history of previous velocity value.

Definition at line 104 of file ImplicitTimeIntegrator.hpp.

References v_prevs_.

Referenced by init(), and save_state().

Here is the caller graph for this function:

◆ x_prev()

const Eigen::VectorXd & polyfem::time_integrator::ImplicitTimeIntegrator::x_prev ( ) const
inline

Get the most recent previous solution value.

Definition at line 95 of file ImplicitTimeIntegrator.hpp.

References x_prevs_.

Referenced by polyfem::time_integrator::ImplicitEuler::compute_velocity(), polyfem::time_integrator::ImplicitNewmark::compute_velocity(), save_state(), set_x_prev(), polyfem::time_integrator::BDF::weighted_sum_x_prevs(), polyfem::time_integrator::ImplicitEuler::x_tilde(), and polyfem::time_integrator::ImplicitNewmark::x_tilde().

Here is the caller graph for this function:

◆ x_prevs()

const std::deque< Eigen::VectorXd > & polyfem::time_integrator::ImplicitTimeIntegrator::x_prevs ( ) const
inline

Get the (relevant) history of previous solution value.

Definition at line 102 of file ImplicitTimeIntegrator.hpp.

References x_prevs_.

Referenced by init(), and save_state().

Here is the caller graph for this function:

◆ x_tilde()

virtual Eigen::VectorXd polyfem::time_integrator::ImplicitTimeIntegrator::x_tilde ( ) const
pure virtual

Compute the predicted solution to be used in the inertia term \((x-\tilde{x})^TM(x-\tilde{x})\).

Returns
value for \(\tilde{x}\)

Implemented in polyfem::time_integrator::BDF, polyfem::time_integrator::ImplicitEuler, and polyfem::time_integrator::ImplicitNewmark.

Referenced by polyfem::solver::InertiaForm::update_quantities().

Here is the caller graph for this function:

Member Data Documentation

◆ a_prevs_

std::deque<Eigen::VectorXd> polyfem::time_integrator::ImplicitTimeIntegrator::a_prevs_
protected

Store the necessary previous values of the acceleration for single or multi-step integration.

Definition at line 126 of file ImplicitTimeIntegrator.hpp.

Referenced by a_prev(), a_prevs(), init(), set_a_prev(), and polyfem::time_integrator::BDF::update_quantities().

◆ dt_

double polyfem::time_integrator::ImplicitTimeIntegrator::dt_ = 1
protected

Time step size.

Default of one for static sims, this should be set using init().

Definition at line 119 of file ImplicitTimeIntegrator.hpp.

Referenced by dt(), and init().

◆ dynamic_order_

const DynamicOrder polyfem::time_integrator::ImplicitTimeIntegrator::dynamic_order_
protected

Definition at line 112 of file ImplicitTimeIntegrator.hpp.

Referenced by polyfem::time_integrator::BDF::acceleration_scaling(), polyfem::time_integrator::ImplicitEuler::acceleration_scaling(), polyfem::time_integrator::BDF::compute_acceleration(), polyfem::time_integrator::ImplicitEuler::compute_acceleration(), polyfem::time_integrator::BDF::x_tilde(), and polyfem::time_integrator::ImplicitEuler::x_tilde().

◆ v_prevs_

std::deque<Eigen::VectorXd> polyfem::time_integrator::ImplicitTimeIntegrator::v_prevs_
protected

Store the necessary previous values of the velocity for single or multi-step integration.

Definition at line 124 of file ImplicitTimeIntegrator.hpp.

Referenced by init(), set_v_prev(), polyfem::time_integrator::BDF::update_quantities(), v_prev(), v_prevs(), and polyfem::time_integrator::BDF::weighted_sum_v_prevs().

◆ x_prevs_

std::deque<Eigen::VectorXd> polyfem::time_integrator::ImplicitTimeIntegrator::x_prevs_
protected

Store the necessary previous values of the solution for single or multi-step integration.

Definition at line 122 of file ImplicitTimeIntegrator.hpp.

Referenced by init(), set_x_prev(), steps(), polyfem::time_integrator::BDF::update_quantities(), polyfem::time_integrator::BDF::weighted_sum_x_prevs(), x_prev(), and x_prevs().

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