dune-fem  2.4.1-rc
Classes | Public Types | Public Member Functions | List of all members
Dune::Fem::SpaceOperatorInterface< DiscreteFunction > Class Template Referenceabstract

interface for time evolution operators More...

#include </local/tomalk/somewhere/tmp/dune-fem/dune/fem/operator/common/spaceoperatorif.hh>

Inheritance diagram for Dune::Fem::SpaceOperatorInterface< DiscreteFunction >:
Inheritance graph

Classes

struct  CallDoubleOperator
 
struct  CallDoubleOperator< Op, AdaptiveDiscreteFunction< SpaceType >, double >
 

Public Types

typedef DiscreteFunction DestinationType
 type of argument and destination More...
 
typedef DestinationType::DiscreteFunctionSpaceType SpaceType
 type of discrete function space More...
 
typedef BaseType::RangeFunctionType RangeFunctionType
 
typedef BaseType::DomainFunctionType DomainFunctionType
 
typedef BaseType::RangeFieldType RangeFieldType
 
typedef BaseType::DomainFieldType DomainFieldType
 
typedef Dune::FieldTraits< RangeFieldType >::real_type RealType
 
typedef BaseType::JacobianOperatorType JacobianOperatorType
 
typedef RangeFunctionType::DiscreteFunctionSpaceType RangeSpaceType
 
typedef DomainFunctionType::DiscreteFunctionSpaceType DomainSpaceType
 

Public Member Functions

virtual ~SpaceOperatorInterface ()
 destructor More...
 
virtual const SpaceTypespace () const =0
 return reference to space (needed by ode solvers) More...
 
virtual int size () const
 return size of discrete function space, i.e. number of unknowns More...
 
virtual void operator() (const double *u, double *f) const
 application operator to apply right hand side More...
 
virtual void limit (const double *u, double *f) const
 limiter application operator More...
 
virtual bool hasLimiter () const
 return true if explicit limiter is available More...
 
virtual void limit (const DestinationType &arg, DestinationType &dest) const
 limiter application operator More...
 
virtual void initializeTimeStepSize (const DestinationType &U0) const
 call operator once to calculate initial time step size More...
 
virtual const DestinationTypedestination () const
 return reference to pass's local memory More...
 
virtual void jacobian (const DomainFunctionType &u, JacobianOperatorType &jOp) const
 
virtual void jacobian (const DomainFunctionType &u, JacobianOperatorType &jOp) const =0
 obtain linearization More...
 
virtual void operator() (const DomainFunctionType &u, RangeFunctionType &w) const =0
 application operator More...
 
virtual void setTime (const double time)
 set time for operators More...
 
virtual double timeStepEstimate () const
 estimate maximum time step More...
 

Detailed Description

template<class DiscreteFunction>
class Dune::Fem::SpaceOperatorInterface< DiscreteFunction >

interface for time evolution operators

The SpaceOperatorInterface defines an interface for operators $L: X \longrightarrow X$ from a discrete function space $X$ into itself. This interface is used to implement operators working with the ODE solvers.

Template Parameters
DiscreteFunctiontype of discretefunction modelling the elements of $X$.
An interface class:

Member Typedef Documentation

template<class DiscreteFunction>
typedef DiscreteFunction Dune::Fem::SpaceOperatorInterface< DiscreteFunction >::DestinationType

type of argument and destination

typedef BaseType::DomainFieldType Dune::Fem::AutomaticDifferenceOperator< DiscreteFunction , DiscreteFunction , AutomaticDifferenceLinearOperator< DiscreteFunction , DiscreteFunction > >::DomainFieldType
inherited
typedef BaseType::DomainFunctionType Dune::Fem::AutomaticDifferenceOperator< DiscreteFunction , DiscreteFunction , AutomaticDifferenceLinearOperator< DiscreteFunction , DiscreteFunction > >::DomainFunctionType
inherited
typedef DomainFunctionType::DiscreteFunctionSpaceType Dune::Fem::AutomaticDifferenceOperator< DiscreteFunction , DiscreteFunction , AutomaticDifferenceLinearOperator< DiscreteFunction , DiscreteFunction > >::DomainSpaceType
inherited
typedef BaseType::JacobianOperatorType Dune::Fem::AutomaticDifferenceOperator< DiscreteFunction , DiscreteFunction , AutomaticDifferenceLinearOperator< DiscreteFunction , DiscreteFunction > >::JacobianOperatorType
inherited
typedef BaseType::RangeFieldType Dune::Fem::AutomaticDifferenceOperator< DiscreteFunction , DiscreteFunction , AutomaticDifferenceLinearOperator< DiscreteFunction , DiscreteFunction > >::RangeFieldType
inherited
typedef BaseType::RangeFunctionType Dune::Fem::AutomaticDifferenceOperator< DiscreteFunction , DiscreteFunction , AutomaticDifferenceLinearOperator< DiscreteFunction , DiscreteFunction > >::RangeFunctionType
inherited
typedef RangeFunctionType::DiscreteFunctionSpaceType Dune::Fem::AutomaticDifferenceOperator< DiscreteFunction , DiscreteFunction , AutomaticDifferenceLinearOperator< DiscreteFunction , DiscreteFunction > >::RangeSpaceType
inherited
typedef Dune::FieldTraits< RangeFieldType >::real_type Dune::Fem::AutomaticDifferenceOperator< DiscreteFunction , DiscreteFunction , AutomaticDifferenceLinearOperator< DiscreteFunction , DiscreteFunction > >::RealType
inherited
template<class DiscreteFunction>
typedef DestinationType::DiscreteFunctionSpaceType Dune::Fem::SpaceOperatorInterface< DiscreteFunction >::SpaceType

type of discrete function space

Constructor & Destructor Documentation

template<class DiscreteFunction>
virtual Dune::Fem::SpaceOperatorInterface< DiscreteFunction >::~SpaceOperatorInterface ( )
inlinevirtual

destructor

Member Function Documentation

template<class DiscreteFunction>
virtual const DestinationType* Dune::Fem::SpaceOperatorInterface< DiscreteFunction >::destination ( ) const
inlinevirtual
template<class DiscreteFunction>
virtual bool Dune::Fem::SpaceOperatorInterface< DiscreteFunction >::hasLimiter ( ) const
inlinevirtual

return true if explicit limiter is available

Reimplemented from Dune::Fem::PARDGSpaceOperatorInterface< DiscreteFunction >.

template<class DiscreteFunction >
void Dune::Fem::SpaceOperatorInterface< DiscreteFunction >::initializeTimeStepSize ( const DestinationType U0) const
inlinevirtual

call operator once to calculate initial time step size

Parameters
U0initial data to compute initial time step size

Implements Dune::Fem::PARDGSpaceOperatorInterface< DiscreteFunction >.

Referenced by Dune::Fem::SpaceOperatorInterface< DiscreteFunction >::limit().

virtual void Dune::Fem::DifferentiableOperator< AutomaticDifferenceLinearOperator< DiscreteFunction, DiscreteFunction > >::jacobian ( const DomainFunctionType u,
JacobianOperatorType jOp 
) const
pure virtualinherited

obtain linearization

Parameters
[in]uargument discrete function
[out]jOpdestination Jacobian operator
Note
This method has to be implemented by all derived classes.
virtual void Dune::Fem::AutomaticDifferenceOperator< DiscreteFunction , DiscreteFunction , AutomaticDifferenceLinearOperator< DiscreteFunction , DiscreteFunction > >::jacobian ( const DomainFunctionType u,
JacobianOperatorType jOp 
) const
inlinevirtualinherited
template<class DiscreteFunction >
void Dune::Fem::SpaceOperatorInterface< DiscreteFunction >::limit ( const double *  u,
double *  f 
) const
inlinevirtual
template<class DiscreteFunction>
virtual void Dune::Fem::SpaceOperatorInterface< DiscreteFunction >::limit ( const DestinationType arg,
DestinationType dest 
) const
inlinevirtual

limiter application operator

Parameters
argargument, u
destdestination, Limiter(u)
virtual void Dune::Fem::Operator< AutomaticDifferenceLinearOperator< DiscreteFunction, DiscreteFunction >::DomainFunctionType , AutomaticDifferenceLinearOperator< DiscreteFunction, DiscreteFunction >::RangeFunctionType >::operator() ( const DomainFunctionType u,
RangeFunctionType w 
) const
pure virtualinherited

application operator

Parameters
[in]uargument discrete function
[out]wdestination discrete function
Note
This method has to be implemented by all derived classes.
template<class DiscreteFunction >
void Dune::Fem::SpaceOperatorInterface< DiscreteFunction >::operator() ( const double *  u,
double *  f 
) const
inlinevirtual

application operator to apply right hand side

Parameters
uargument, u
fdestination, f(u)

Implements Dune::Fem::PARDGSpaceOperatorInterface< DiscreteFunction >.

References Dune::Fem::SpaceOperatorInterface< DiscreteFunction >::limit().

Referenced by Dune::Fem::SpaceOperatorWrapper< OperatorType >::operator()().

virtual void Dune::Fem::PARDGSpaceOperatorInterface< DiscreteFunction >::setTime ( const double  time)
inlinevirtualinherited

set time for operators

Parameters
timecurrent time of evaluation
template<class DiscreteFunction>
virtual int Dune::Fem::SpaceOperatorInterface< DiscreteFunction >::size ( ) const
inlinevirtual

return size of discrete function space, i.e. number of unknowns

Implements Dune::Fem::PARDGSpaceOperatorInterface< DiscreteFunction >.

template<class DiscreteFunction>
virtual const SpaceType& Dune::Fem::SpaceOperatorInterface< DiscreteFunction >::space ( ) const
pure virtual

return reference to space (needed by ode solvers)

Implemented in Dune::Fem::SpaceOperatorPtr< OperatorType >, and Dune::Fem::HdivProjection< DiscreteFunctionType >.

virtual double Dune::Fem::PARDGSpaceOperatorInterface< DiscreteFunction >::timeStepEstimate ( ) const
inlinevirtualinherited

estimate maximum time step

For an explicit time discretization, the time step has to be limited. An estimate for the maximum time step of an explicit Euler scheme is returned by this function. Maximum time steps for higher order Runge Kutta schemes can be derived from this value.

References Dune::Std::max().


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