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

#include <example_integrator.h>

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

Public Member Functions

int integrate (ptr_passer u, double t0, double tf)
std::string type () const
 Returns the typename of the current class.
std::vector< std::stringdependencies () const
 Returns the variables that this class depends on.
void postprocess (input &inval)
 Processes the input data.
const std::type_info & vtype () const
 Returns the type of the integrator.
- Public Member Functions inherited from integrator
virtual void initial_condition (ptr_passer in, size_t len)
void initial_condition (ptr_passer in)
virtual ~integrator ()
 Blank destructor for integrator.
- 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::stringname () const
const std::stringwrite_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 ()

Private Attributes

std::shared_ptr
< example_integrator
actual_int
 Holds a collected pointer to the actual integrator being used.

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 integrator
rhsrh_val

Detailed Description

Definition at line 22 of file example_integrator.h.

Member Function Documentation

std::vector< std::string > example_integrator::dependencies ( ) const
virtual

Returns the variables that this class depends on.

This class depends on

  • double rval1: Some parameter
  • int rval2: Some other parameter, optional value of -1
  • unsigned unsigned_var: Something random
  • string something: Some third parameter

Implements integrator.

Definition at line 34 of file example_integrator.cpp.

Here is the call graph for this function:

int example_integrator::integrate ( ptr_passer  u,
double  t0,
double  tf 
)
virtual
See Also
integrator::integrate

Implements integrator.

Reimplemented in example_integrator_tmpl< T >.

Definition at line 24 of file example_integrator.cpp.

void example_integrator::postprocess ( input inval)
virtual

Processes the input data.

Reimplemented from integrator.

Reimplemented in example_integrator_tmpl< T >.

Definition at line 44 of file example_integrator.cpp.

Here is the call graph for this function:

std::string example_integrator::type ( ) const
virtual

Returns the typename of the current class.

Implements integrator.

Reimplemented in example_integrator_tmpl< T >.

Definition at line 28 of file example_integrator.cpp.

const std::type_info & example_integrator::vtype ( ) const
virtual

Returns the type of the integrator.

See Also
vartype

Implements vartype.

Reimplemented in example_integrator_tmpl< T >.

Definition at line 57 of file example_integrator.cpp.

Member Data Documentation

std::shared_ptr<example_integrator> example_integrator::actual_int
private

Holds a collected pointer to the actual integrator being used.

Definition at line 27 of file example_integrator.h.


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