LILAC
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
rhs Class Reference

The rhs base class. More...

#include <rhs.h>

Inheritance diagram for rhs:
Inheritance graph
[legend]
Collaboration diagram for rhs:
Collaboration graph
[legend]

Public Member Functions

 rhs ()
 Creates the base rhs class with a dimension=dimen.
virtual void initial_condition (ptr_passer x, size_t len)=0
void initial_condition (ptr_passer x)
 Wrapper for intial_condition that assumes the length is equal to dimension.
virtual int dxdt (ptr_passer x, ptr_passer dx, double t)=0
 Stores the derivative in dx given the time t and current x.
virtual ~rhs ()
- Public Member Functions inherited from item_dim
size_t get_dimension () const
virtual void postprocess (input &dat)
virtual std::vector< std::stringdependencies () const =0
- Public Member Functions inherited from item
 item ()
virtual ~item ()
virtual void print () const
 Standard print function.
virtual void update ()
virtual std::string type () const =0
void setname (const std::string n)
void set_write_name (std::string wname)
const std::stringname () const
const std::stringwrite_name () const
- Public Member Functions inherited from vartype
virtual const std::type_info & vtype () const =0
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 ()

Additional Inherited Members

- Static Public Member Functions inherited from item
static std::shared_ptr< itemcreate (std::string name, engineimp *rval)
- Public Attributes inherited from item
engineimpholder
- 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)
- Protected Attributes inherited from item_dim
mempool memp
std::set< item_dim * > children
item_dimparent
size_t dimension

Detailed Description

The rhs base class.

The RHS class provides the RHS of an equation du/dt = f(u) This is an abstract virtual class that provides a uniform interface to the integrator class. Aside from the standard item functions, derived classes must implement a function dxdt which loads an array with the derivative at a certain time given the time and function value

The array is a void pointer as to allow users to

See Also
integrator

Definition at line 34 of file rhs.h.

Constructor & Destructor Documentation

rhs::rhs ( )
inline

Creates the base rhs class with a dimension=dimen.

Definition at line 39 of file rhs.h.

virtual rhs::~rhs ( )
inlinevirtual

Definition at line 54 of file rhs.h.

Member Function Documentation

virtual int rhs::dxdt ( ptr_passer  x,
ptr_passer  dx,
double  t 
)
pure virtual

Stores the derivative in dx given the time t and current x.

Implemented in example_rhs, c_elegans, rhs_CNLS, and rhs_SQGLE.

virtual void rhs::initial_condition ( ptr_passer  x,
size_t  len 
)
pure virtual

Initializes the generic initial condition for the problem at hand

Implemented in c_elegans, rhs_type< double, rhs_sde >, and rhs_type< comp >.

Here is the caller graph for this function:

void rhs::initial_condition ( ptr_passer  x)
inline

Wrapper for intial_condition that assumes the length is equal to dimension.

Definition at line 47 of file rhs.h.

Here is the call graph for this function:


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