dune-pdelab  2.0.0
Public Types | Public Member Functions | Static Public Attributes | List of all members
Dune::PDELab::MultiStepParameterInterface< value_type_, order_ > Class Template Referenceabstract

Base parameter class for multi step time schemes. More...

#include <dune/pdelab/multistep/parameter.hh>

Inheritance diagram for Dune::PDELab::MultiStepParameterInterface< value_type_, order_ >:
Inheritance graph

Public Types

typedef value_type_ value_type
 export type of the parameters More...
 

Public Member Functions

virtual unsigned steps () const =0
 Return number of steps of the method. More...
 
virtual value_type alpha (int step, int deriv) const =0
 Return alpha coefficients. More...
 
virtual std::string name () const =0
 Return name of the scheme. More...
 
virtual ~MultiStepParameterInterface ()
 every abstract base class has a virtual destructor More...
 

Static Public Attributes

static const unsigned order = order_
 Order of the problems this method is apropriate for. More...
 

Detailed Description

template<typename value_type_, unsigned order_>
class Dune::PDELab::MultiStepParameterInterface< value_type_, order_ >

Base parameter class for multi step time schemes.

Template Parameters
value_type_C++ type of the floating point parameters
order_Order of the ODE's this scheme is apropriate for.

Member Typedef Documentation

template<typename value_type_, unsigned order_>
typedef value_type_ Dune::PDELab::MultiStepParameterInterface< value_type_, order_ >::value_type

export type of the parameters

Constructor & Destructor Documentation

template<typename value_type_, unsigned order_>
virtual Dune::PDELab::MultiStepParameterInterface< value_type_, order_ >::~MultiStepParameterInterface ( )
inlinevirtual

every abstract base class has a virtual destructor

Member Function Documentation

template<typename value_type_, unsigned order_>
virtual value_type Dune::PDELab::MultiStepParameterInterface< value_type_, order_ >::alpha ( int  step,
int  deriv 
) const
pure virtual

Return alpha coefficients.

Return $\alpha_{\text{\tt step}, \text{\tt deriv}}$.

Note
step ∈ [0,...,steps()] and deriv ∈ [0,...,order]
If a coefficient is numerically zero ( $\alpha_{\text{\tt step}, \text{\tt deriv}}=0$), the MultiStepGridOperatorSpace may skip certain loops. To take advantage of this, a particular Parameters implementation should take care to force a parameter to exactly zero before returning it, if it is practically zero and if it is calculated in a way that may result in slightly off-zero values. This way, the meaning of "practically zero" is up to the Parameters implementation.

Implemented in Dune::PDELab::NewmarkBetaParameters< value_type >, and Dune::PDELab::CentralDifferencesParameters< value_type >.

template<typename value_type_, unsigned order_>
virtual std::string Dune::PDELab::MultiStepParameterInterface< value_type_, order_ >::name ( ) const
pure virtual
template<typename value_type_, unsigned order_>
virtual unsigned Dune::PDELab::MultiStepParameterInterface< value_type_, order_ >::steps ( ) const
pure virtual

Member Data Documentation

template<typename value_type_, unsigned order_>
const unsigned Dune::PDELab::MultiStepParameterInterface< value_type_, order_ >::order = order_
static

Order of the problems this method is apropriate for.


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