AnimaL

Tutorial

Documentation

---

Documentation

• Overview
• Modules
• Namespace List
• Class Hierarchy
• Alphabetical List
• Compound List
• File List
• Namespace Members
• Compound Members
• File Members
• Examples

---

animal::integration::IsDifferent_Function< TraitsT > Struct Template Reference

#include <stepper.h>

List of all members.

---

Detailed Description

template<class TraitsT>
struct animal::integration::IsDifferent_Function< TraitsT >

Criterion for modifying time step value.

Definition at line 129 of file stepper.h.

Public Types
typedef TraitsT::Real	Real
	time
typedef TraitsT::Model	Model
	additional data
typedef TraitsT::State	State
	function value
typedef TraitsT::Derivative	Derivative
	function derivative
typedef TraitsT::Numerics	Numerics
	numerical traits
Public Member Functions
Real	errormax (const Model &M, const State &S, const Real t) const
	Required accuracy.
Call operator
bool	operator() (const Model &M, const State &S1, const State &S2, const Real t) const
	Compare two states according to a criterion.
bool	operator() (const Model &M, const State &S, const Real t) const
	Compare one state to a constant.

---

Member Typedef Documentation

template<class TraitsT> typedef TraitsT::Derivative animal::integration::IsDifferent_Function< TraitsT >::Derivative

function derivative Definition at line 134 of file stepper.h.

template<class TraitsT> typedef TraitsT::Model animal::integration::IsDifferent_Function< TraitsT >::Model

additional data Definition at line 132 of file stepper.h.

template<class TraitsT> typedef TraitsT::Numerics animal::integration::IsDifferent_Function< TraitsT >::Numerics

numerical traits Definition at line 135 of file stepper.h.

template<class TraitsT> typedef TraitsT::Real animal::integration::IsDifferent_Function< TraitsT >::Real

time Definition at line 131 of file stepper.h.

template<class TraitsT> typedef TraitsT::State animal::integration::IsDifferent_Function< TraitsT >::State

function value Definition at line 133 of file stepper.h.

---

Member Function Documentation

template<class TraitsT> Real animal::integration::IsDifferent_Function< TraitsT >::errormax (  const Model &  M, const State &  S, const Real  t )  const

Required accuracy.

template<class TraitsT> bool animal::integration::IsDifferent_Function< TraitsT >::operator() (  const Model &  M, const State &  S, const Real  t )  const

Compare one state to a constant.

template<class TraitsT> bool animal::integration::IsDifferent_Function< TraitsT >::operator() (  const Model &  M, const State &  S1, const State &  S2, const Real  t )  const

Compare two states according to a criterion.

---

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

• stepper.h

---