svZeroDSolver
Loading...
Searching...
No Matches
Integrator Class Reference

Generalized-alpha integrator. More...

#include <Integrator.h>

Public Member Functions

 Integrator (Model *model, double time_step_size, double rho, double atol, int max_iter)
 Construct a new Integrator object.
 
 Integrator ()
 Construct a new Integrator object.
 
 ~Integrator ()
 Destroy the Integrator object.
 
void clean ()
 Delete dynamically allocated memory (in class member SparseSystem<double> system).
 
void update_params (double time_step_size)
 Update integrator parameter and system matrices with model parameter updates.
 
State step (const State &state, double time)
 Perform a time step.
 
double avg_nonlin_iter ()
 Get average number of nonlinear iterations in all step calls.
 

Detailed Description

Generalized-alpha integrator.

This class handles the time integration scheme for solving 0D blood flow system using the generalized- $\alpha$ method [1].

Mathematical details are available on the SimVascular documentation.

Constructor & Destructor Documentation

◆ Integrator() [1/2]

Integrator::Integrator ( Model * model,
double time_step_size,
double rho,
double atol,
int max_iter )

Construct a new Integrator object.

Parameters
modelThe model to simulate
time_step_sizeTime step size for generalized-alpha step
rhoSpectral radius for generalized-alpha step
atolAbsolut tolerance for non-linear iteration termination
max_iterMaximum number of non-linear iterations

◆ Integrator() [2/2]

Integrator::Integrator ( )

Construct a new Integrator object.

◆ ~Integrator()

Integrator::~Integrator ( )

Destroy the Integrator object.

Member Function Documentation

◆ avg_nonlin_iter()

double Integrator::avg_nonlin_iter ( )

Get average number of nonlinear iterations in all step calls.

Returns
Average number of nonlinear iterations in all step calls

◆ clean()

void Integrator::clean ( )

Delete dynamically allocated memory (in class member SparseSystem<double> system).

◆ step()

State Integrator::step ( const State & state,
double time )

Perform a time step.

Parameters
stateCurrent state
timeCurrent time
Returns
New state

◆ update_params()

void Integrator::update_params ( double time_step_size)

Update integrator parameter and system matrices with model parameter updates.

Parameters
time_step_sizeTime step size for 0D model

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