belfem::ode::Integrator Class Reference

#include <cl_ODE_Integrator.hpp>

Public Member Functions
	Integrator (ODE &aObject, const Type aType)
	~Integrator ()=default
real &	epsilon ()
	return the convergence criterion
uint &	max_num_iterations ()
	set the maximum number of iterations
real &	time ()
	return t-coordinate
real &	maxtime ()
real &	timestep ()
	return the current timestep
Status	step (real &aT, Vector< real > &aY)
	perform one single step
const Type &	type () const
	return the type
void	set_auto_timestep (const bool aAutoTimestep=true)
	set the autotimestep flag

Constructor & Destructor Documentation

Integrator()

belfem::ode::Integrator::Integrator	(	ODE &	aObject,
		const Type	aType )

~Integrator()

belfem::ode::Integrator::~Integrator ( )

default

Member Function Documentation

epsilon()

real & belfem::ode::Integrator::epsilon ( )

inline

return the convergence criterion

max_num_iterations()

uint & belfem::ode::Integrator::max_num_iterations ( )

inline

set the maximum number of iterations

maxtime()

real & belfem::ode::Integrator::maxtime ( )

inline

set_auto_timestep()

void belfem::ode::Integrator::set_auto_timestep ( const bool aAutoTimestep = true )

inline

set the autotimestep flag

step()

Status belfem::ode::Integrator::step	(	real &	aT,
		Vector< real > &	aY )

perform one single step

time()

real & belfem::ode::Integrator::time ( )

inline

return t-coordinate

timestep()

real & belfem::ode::Integrator::timestep ( )

inline

return the current timestep

type()

const Type & belfem::ode::Integrator::type ( ) const

inline

return the type

---

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

• src/numerics/ode/cl_ODE_Integrator.hpp
• src/numerics/ode/cl_ODE_Integrator.cpp