dune-fem 2.8.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | List of all members
Dune::Fem::SpaceOperatorInterface< DiscreteFunction, JacobianOperator > Class Template Referenceabstract

interface for time evolution operators More...

#include <dune/fem/operator/common/spaceoperatorif.hh>

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

Public Types

typedef DiscreteFunction DestinationType
 type of argument and destination
 
typedef DestinationType::DiscreteFunctionSpaceType DiscreteFunctionSpaceType
 type of discrete function space
 
typedef DiscreteFunctionSpaceType SpaceType
 convenience typedef for space type
 
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
 
virtual const DiscreteFunctionSpaceTypespace () const =0
 return reference to space (needed by ode solvers)
 
virtual int size () const
 return size of discrete function space, i.e. number of unknowns
 
virtual void initializeTimeStepSize (const DestinationType &U0) const
 call operator once to calculate initial time step size
 
virtual bool hasLimiter () const
 return true if limit method is implemented
 
virtual void setTime (const double time)
 set time for operators
 
virtual double timeStepEstimate () const
 estimate maximum time step
 
virtual void limit (const DestinationType &arg, DestinationType &dest) const
 limiter application operator
 
virtual void applyLimiter (DestinationType &U) const
 limiter application operator
 
virtual const DestinationTypedestination () const
 return reference to pass's local memory
 
virtual void jacobian (const DomainFunctionType &u, JacobianOperatorType &jOp) const
 
virtual void jacobian (const DomainFunctionType &u, JacobianOperatorType &jOp) const =0
 obtain linearization
 
virtual void operator() (const DomainFunctionType &u, RangeFunctionType &w) const=0
 application operator
 
virtual void finalize ()
 finalization of operator
 

Protected Attributes

std::unique_ptr< DestinationTypeuTmp_
 

Detailed Description

template<class DiscreteFunction, class JacobianOperator = Fem::AutomaticDifferenceOperator< DiscreteFunction >>
class Dune::Fem::SpaceOperatorInterface< DiscreteFunction, JacobianOperator >

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

◆ DestinationType

template<class DiscreteFunction , class JacobianOperator = Fem::AutomaticDifferenceOperator< DiscreteFunction >>
typedef DiscreteFunction Dune::Fem::SpaceOperatorInterface< DiscreteFunction, JacobianOperator >::DestinationType

type of argument and destination

◆ DiscreteFunctionSpaceType

template<class DiscreteFunction , class JacobianOperator = Fem::AutomaticDifferenceOperator< DiscreteFunction >>
typedef DestinationType::DiscreteFunctionSpaceType Dune::Fem::SpaceOperatorInterface< DiscreteFunction, JacobianOperator >::DiscreteFunctionSpaceType

type of discrete function space

◆ DomainFieldType

typedef BaseType::DomainFieldType Dune::Fem::AutomaticDifferenceOperator< DiscreteFunction , DiscreteFunction , AutomaticDifferenceLinearOperator< DiscreteFunction , DiscreteFunction > >::DomainFieldType
inherited

◆ DomainFunctionType

typedef BaseType::DomainFunctionType Dune::Fem::AutomaticDifferenceOperator< DiscreteFunction , DiscreteFunction , AutomaticDifferenceLinearOperator< DiscreteFunction , DiscreteFunction > >::DomainFunctionType
inherited

◆ DomainSpaceType

typedef DomainFunctionType::DiscreteFunctionSpaceType Dune::Fem::AutomaticDifferenceOperator< DiscreteFunction , DiscreteFunction , AutomaticDifferenceLinearOperator< DiscreteFunction , DiscreteFunction > >::DomainSpaceType
inherited

◆ JacobianOperatorType

typedef BaseType::JacobianOperatorType Dune::Fem::AutomaticDifferenceOperator< DiscreteFunction , DiscreteFunction , AutomaticDifferenceLinearOperator< DiscreteFunction , DiscreteFunction > >::JacobianOperatorType
inherited

◆ RangeFieldType

typedef BaseType::RangeFieldType Dune::Fem::AutomaticDifferenceOperator< DiscreteFunction , DiscreteFunction , AutomaticDifferenceLinearOperator< DiscreteFunction , DiscreteFunction > >::RangeFieldType
inherited

◆ RangeFunctionType

typedef BaseType::RangeFunctionType Dune::Fem::AutomaticDifferenceOperator< DiscreteFunction , DiscreteFunction , AutomaticDifferenceLinearOperator< DiscreteFunction , DiscreteFunction > >::RangeFunctionType
inherited

◆ RangeSpaceType

typedef RangeFunctionType::DiscreteFunctionSpaceType Dune::Fem::AutomaticDifferenceOperator< DiscreteFunction , DiscreteFunction , AutomaticDifferenceLinearOperator< DiscreteFunction , DiscreteFunction > >::RangeSpaceType
inherited

◆ RealType

typedef Dune::FieldTraits<RangeFieldType>::real_type Dune::Fem::AutomaticDifferenceOperator< DiscreteFunction , DiscreteFunction , AutomaticDifferenceLinearOperator< DiscreteFunction , DiscreteFunction > >::RealType
inherited

◆ SpaceType

template<class DiscreteFunction , class JacobianOperator = Fem::AutomaticDifferenceOperator< DiscreteFunction >>
typedef DiscreteFunctionSpaceType Dune::Fem::SpaceOperatorInterface< DiscreteFunction, JacobianOperator >::SpaceType

convenience typedef for space type

Constructor & Destructor Documentation

◆ ~SpaceOperatorInterface()

template<class DiscreteFunction , class JacobianOperator = Fem::AutomaticDifferenceOperator< DiscreteFunction >>
virtual Dune::Fem::SpaceOperatorInterface< DiscreteFunction, JacobianOperator >::~SpaceOperatorInterface ( )
inlinevirtual

destructor

Member Function Documentation

◆ applyLimiter()

template<class DiscreteFunction , class JacobianOperator = Fem::AutomaticDifferenceOperator< DiscreteFunction >>
virtual void Dune::Fem::SpaceOperatorInterface< DiscreteFunction, JacobianOperator >::applyLimiter ( DestinationType U) const
inlinevirtual

limiter application operator

Parameters
[in,out]Uargument and destination to apply Limiter(u), needs internal copying
Note
: Default implementation is to do nothing (hasLimiter == false)

◆ destination()

template<class DiscreteFunction , class JacobianOperator = Fem::AutomaticDifferenceOperator< DiscreteFunction >>
virtual const DestinationType * Dune::Fem::SpaceOperatorInterface< DiscreteFunction, JacobianOperator >::destination ( ) const
inlinevirtual

return reference to pass's local memory

Reimplemented in Dune::Fem::SpaceOperatorPtr< OperatorType >.

◆ finalize()

virtual void Dune::Fem::Operator< JacobianOperator::DomainFunctionType , JacobianOperator::RangeFunctionType >::finalize ( )
inlinevirtualinherited

finalization of operator

Note
The default implementation is empty.

◆ hasLimiter()

template<class DiscreteFunction , class JacobianOperator = Fem::AutomaticDifferenceOperator< DiscreteFunction >>
virtual bool Dune::Fem::SpaceOperatorInterface< DiscreteFunction, JacobianOperator >::hasLimiter ( ) const
inlinevirtual

return true if limit method is implemented

Returns
true if limit is implemented

◆ initializeTimeStepSize()

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

call operator once to calculate initial time step size

Parameters
U0initial data to compute initial time step size

◆ jacobian() [1/2]

virtual void Dune::Fem::AutomaticDifferenceOperator< DiscreteFunction , DiscreteFunction , AutomaticDifferenceLinearOperator< DiscreteFunction , DiscreteFunction > >::jacobian ( const DomainFunctionType u,
JacobianOperatorType jOp 
) const
inlinevirtualinherited

◆ jacobian() [2/2]

template<class JacobianOperator >
virtual void Dune::Fem::DifferentiableOperator< JacobianOperator >::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.

Implemented in Dune::Fem::DifferentiableGalerkinOperator< Integrands, JacobianOperator >, and Dune::Fem::MOLDifferentiableGalerkinOperator< Integrands, JacobianOperator >.

◆ limit()

template<class DiscreteFunction , class JacobianOperator = Fem::AutomaticDifferenceOperator< DiscreteFunction >>
virtual void Dune::Fem::SpaceOperatorInterface< DiscreteFunction, JacobianOperator >::limit ( const DestinationType arg,
DestinationType dest 
) const
inlinevirtual

limiter application operator

Parameters
argargument, u
destdestination, Limiter(u)
Note
: Default implementation is to copy arg into dest.

◆ operator()()

virtual void Dune::Fem::Operator< JacobianOperator::DomainFunctionType , JacobianOperator::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.

◆ setTime()

template<class DiscreteFunction , class JacobianOperator = Fem::AutomaticDifferenceOperator< DiscreteFunction >>
virtual void Dune::Fem::SpaceOperatorInterface< DiscreteFunction, JacobianOperator >::setTime ( const double  time)
inlinevirtual

set time for operators

Parameters
timecurrent time of evaluation

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

◆ size()

template<class DiscreteFunction , class JacobianOperator = Fem::AutomaticDifferenceOperator< DiscreteFunction >>
virtual int Dune::Fem::SpaceOperatorInterface< DiscreteFunction, JacobianOperator >::size ( ) const
inlinevirtual

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

◆ space()

template<class DiscreteFunction , class JacobianOperator = Fem::AutomaticDifferenceOperator< DiscreteFunction >>
virtual const DiscreteFunctionSpaceType & Dune::Fem::SpaceOperatorInterface< DiscreteFunction, JacobianOperator >::space ( ) const
pure virtual

return reference to space (needed by ode solvers)

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

◆ timeStepEstimate()

template<class DiscreteFunction , class JacobianOperator = Fem::AutomaticDifferenceOperator< DiscreteFunction >>
virtual double Dune::Fem::SpaceOperatorInterface< DiscreteFunction, JacobianOperator >::timeStepEstimate ( ) const
inlinevirtual

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.

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

Member Data Documentation

◆ uTmp_

template<class DiscreteFunction , class JacobianOperator = Fem::AutomaticDifferenceOperator< DiscreteFunction >>
std::unique_ptr< DestinationType > Dune::Fem::SpaceOperatorInterface< DiscreteFunction, JacobianOperator >::uTmp_
mutableprotected

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