ode Class Reference

Integrates an ODE forwards in time. More...

#include <ode.h>

Inheritance diagram for ode:

Collaboration diagram for ode:

Public Member Functions
std::string	type () const
const std::type_info &	vtype () const
std::vector< std::string >	dependencies () const
void	postprocess (input &in)
double	simulate ()
Public Member Functions inherited from simulation
virtual double	score ()
	This function returns the score of the system in its current state.
Public Member Functions inherited from item_dim
size_t	get_dimension () const
Public Member Functions inherited from item
	item ()
virtual	~item ()
virtual void	print () const
	Standard print function.
virtual void	update ()
void	setname (const std::string n)
void	set_write_name (std::string wname)
const std::string &	name () const
const std::string &	write_name () const
Public Member Functions inherited from vartype
bool	compare (const vartype *in) const
bool	compare (const vartype &in) const
bool	compare (const std::type_info &tinf)
template<typename T >
bool	compare () const
template<typename T >
bool	compare (const T &in) const
std::string	vname () const
virtual const std::type_info &	vtype_internal () const
bool	compare_internal (const vartype *in) const
bool	compare_internal (const vartype &in) const
bool	compare_internal (const std::type_info &tinf)
template<typename T >
bool	compare_internal () const
template<typename T >
bool	compare_internal (const T &in) const
std::string	vname_internal () const
virtual	~vartype ()

Protected Attributes
integrator *	inter
Protected Attributes inherited from simulation
controller *	cont
	The controller.
objective *	obj
	The objective function.
writer *	cur_writer
Protected Attributes inherited from item_dim
mempool	memp
std::set< item_dim * >	children
item_dim *	parent
size_t	dimension
Protected Attributes inherited from item
std::string	_name
std::string	_write_name
char	has_write_name

Private Attributes
std::shared_ptr< ode >	actual

Additional Inherited Members
Static Public Member Functions inherited from item
static std::shared_ptr< item >	create (std::string name, engineimp *rval)
Public Attributes inherited from simulation
std::string	out_f_name
Protected Member Functions inherited from item_dim
void	print_upstream ()
virtual void	_do_mem_update (size_t dim_old)
void	add_as_parent (item_dim *p)
void	add_as_parent (std::shared_ptr< item_dim > p)
void	update_dim (size_t dim_new)

Detailed Description

Integrates an ODE forwards in time.

Definition at line 26 of file ode.h.

Member Function Documentation

std::vector< std::string > ode::dependencies ( ) const

virtual

Returns the dependencies of the ode class. The ode class has the same dependencies as the simulation class, as well as:

• double tf: Ending time of the integration

• integrator integrator: Type of interator being used, must be a type that inherits from integrator class

And has optional parameters:

• double t0: Starting time of integration, default value of 0

• double tw: Starting time of writing, default value of t0

• double w_step: Interval to record data, default value of -1.

If w_step<=0 (to machine precision) or tw>= tf, then no recording will be done Only the final value will be saved

Implements simulation.

Definition at line 52 of file ode.cpp.

Here is the call graph for this function:

void ode::postprocess ( input &  in )

virtual

Implements simulation.

Reimplemented in ode_tmpl< T >.

Definition at line 56 of file ode.cpp.

Here is the call graph for this function:

double ode::simulate ( )

virtual

Implements simulation.

Reimplemented in ode_tmpl< T >.

Definition at line 66 of file ode.cpp.

std::string ode::type ( ) const

virtual

This function returns the type name of the ode class, "ode"

Implements item.

Reimplemented in ode_tmpl< T >.

Definition at line 25 of file ode.cpp.

const std::type_info & ode::vtype ( ) const

virtual

Returns the variable type being used by the object,

Implements vartype.

Reimplemented in ode_tmpl< T >.

Definition at line 31 of file ode.cpp.

Member Data Documentation

std::shared_ptr<ode> ode::actual

private

Definition at line 27 of file ode.h.

integrator* ode::inter

protected

Definition at line 29 of file ode.h.

---

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

• simulation/ode.h
• simulation/ode.cpp