dune-pdelab 2.9
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | List of all members
Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit > Class Template Reference

#include <dune/pdelab/gridoperator/onestep.hh>

Classes

struct  MatrixContainer
 

Public Types

typedef GO0::Pattern Pattern
 The sparsity pattern container for the jacobian matrix.
 
typedef GO0::Traits::Assembler Assembler
 The global UDG assembler type.
 
typedef OneStepLocalAssembler< OneStepGridOperator, LocalAssemblerDT0, LocalAssemblerDT1 > LocalAssembler
 The local assembler type.
 
typedef GO0::BorderDOFExchanger BorderDOFExchanger
 The BorderDOFExchanger.
 
typedef Dune::PDELab::GridOperatorTraits< typename GO0::Traits::TrialGridFunctionSpace, typename GO0::Traits::TestGridFunctionSpace, typename GO0::Traits::MatrixBackend, typename GO0::Traits::DomainField, typename GO0::Traits::RangeField, typename GO0::Traits::JacobianField, typename GO0::Traits::TrialGridFunctionSpaceConstraints, typename GO0::Traits::TestGridFunctionSpaceConstraints, Assembler, LocalAssembler > Traits
 The grid operator traits.
 
typedef LocalAssembler::Real Real
 The type for real number e.g. time.
 
typedef LocalAssembler::OneStepParameters OneStepParameters
 The type of the one step method parameters.
 
typedef GO0::Traits::LocalAssembler LocalAssemblerDT0
 
typedef GO1::Traits::LocalAssembler LocalAssemblerDT1
 
typedef Traits::Domain Domain
 
typedef Traits::Range Range
 
typedef Traits::Jacobian Jacobian
 

Public Member Functions

 OneStepGridOperator (GO0 &go0_, GO1 &go1_)
 Constructor for non trivial constraints.
 
void divideMassTermByDeltaT ()
 
void multiplySpatialTermByDeltaT ()
 
const Traits::TrialGridFunctionSpace & trialGridFunctionSpace () const
 Get the trial grid function space.
 
const Traits::TestGridFunctionSpace & testGridFunctionSpace () const
 Get the test grid function space.
 
Traits::TrialGridFunctionSpace::Traits::SizeType globalSizeU () const
 Get dimension of space u.
 
Traits::TestGridFunctionSpace::Traits::SizeType globalSizeV () const
 Get dimension of space v.
 
Assembler & assembler () const
 
LocalAssembler & localAssembler () const
 
void fill_pattern (Pattern &p) const
 Fill pattern of jacobian matrix.
 
void preStage (unsigned int stage, const std::vector< Domain * > &x)
 Assemble constant part of residual.
 
void residual (const Domain &x, Range &r) const
 Assemble residual.
 
void jacobian (const Domain &x, Jacobian &a) const
 Assemble jacobian.
 
void explicit_jacobian_residual (unsigned int stage, const std::vector< Domain * > &x, Jacobian &a, Range &r1, Range &r0)
 Assemble jacobian and residual simultaneously for explicit treatment.
 
void jacobian_apply (const Domain &update, Range &result) const
 Apply jacobian matrix to the vector update without explicitly assembling it.
 
void jacobian_apply (const Domain &solution, const Domain &update, Range &result) const
 Apply jacobian matrix to the vector update without explicitly assembling it.
 
template<typename F , typename X >
void interpolate (unsigned stage, const X &xold, F &f, X &x) const
 Interpolate constrained values from given function f.
 
void setMethod (const TimeSteppingParameterInterface< Real > &method_)
 set time stepping method
 
void preStep (const TimeSteppingParameterInterface< Real > &method_, Real time_, Real dt_)
 parametrize assembler with a time-stepping method
 
void postStep ()
 to be called after step is completed
 
void postStage ()
 to be called after stage is completed
 
Real suggestTimestep (Real dt) const
 to be called once before each stage
 
void update ()
 
void make_consistent (Jacobian &a) const
 
const Traits::MatrixBackend & matrixBackend () const
 
const LocalAssembler::Traits::TrialGridFunctionSpaceConstraints trialConstraints () const
 

Detailed Description

template<typename GO0, typename GO1, bool implicit = true>
class Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >
Examples
recipe-operator-splitting.cc.

Member Typedef Documentation

◆ Assembler

template<typename GO0 , typename GO1 , bool implicit = true>
typedef GO0::Traits::Assembler Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::Assembler

The global UDG assembler type.

◆ BorderDOFExchanger

template<typename GO0 , typename GO1 , bool implicit = true>
typedef GO0::BorderDOFExchanger Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::BorderDOFExchanger

The BorderDOFExchanger.

◆ Domain

template<typename GO0 , typename GO1 , bool implicit = true>
typedef Traits::Domain Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::Domain

The io types of the operator

◆ Jacobian

template<typename GO0 , typename GO1 , bool implicit = true>
typedef Traits::Jacobian Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::Jacobian

◆ LocalAssembler

template<typename GO0 , typename GO1 , bool implicit = true>
typedef OneStepLocalAssembler<OneStepGridOperator,LocalAssemblerDT0,LocalAssemblerDT1> Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::LocalAssembler

The local assembler type.

◆ LocalAssemblerDT0

template<typename GO0 , typename GO1 , bool implicit = true>
typedef GO0::Traits::LocalAssembler Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::LocalAssemblerDT0

The local assembler types of the subordinate grid operators

◆ LocalAssemblerDT1

template<typename GO0 , typename GO1 , bool implicit = true>
typedef GO1::Traits::LocalAssembler Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::LocalAssemblerDT1

◆ OneStepParameters

template<typename GO0 , typename GO1 , bool implicit = true>
typedef LocalAssembler::OneStepParameters Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::OneStepParameters

The type of the one step method parameters.

◆ Pattern

template<typename GO0 , typename GO1 , bool implicit = true>
typedef GO0::Pattern Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::Pattern

The sparsity pattern container for the jacobian matrix.

◆ Range

template<typename GO0 , typename GO1 , bool implicit = true>
typedef Traits::Range Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::Range

◆ Real

template<typename GO0 , typename GO1 , bool implicit = true>
typedef LocalAssembler::Real Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::Real

The type for real number e.g. time.

◆ Traits

template<typename GO0 , typename GO1 , bool implicit = true>
typedef Dune::PDELab::GridOperatorTraits<typename GO0::Traits::TrialGridFunctionSpace, typename GO0::Traits::TestGridFunctionSpace, typename GO0::Traits::MatrixBackend, typename GO0::Traits::DomainField, typename GO0::Traits::RangeField, typename GO0::Traits::JacobianField, typename GO0::Traits::TrialGridFunctionSpaceConstraints, typename GO0::Traits::TestGridFunctionSpaceConstraints, Assembler, LocalAssembler> Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::Traits

The grid operator traits.

Constructor & Destructor Documentation

◆ OneStepGridOperator()

template<typename GO0 , typename GO1 , bool implicit = true>
Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::OneStepGridOperator ( GO0 &  go0_,
GO1 &  go1_ 
)
inline

Constructor for non trivial constraints.

Member Function Documentation

◆ assembler()

template<typename GO0 , typename GO1 , bool implicit = true>
Assembler & Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::assembler ( ) const
inline

◆ divideMassTermByDeltaT()

template<typename GO0 , typename GO1 , bool implicit = true>
void Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::divideMassTermByDeltaT ( )
inline

Determines whether the time step size is multiplied to the mass term (first order time derivative) or the elliptic term (zero-th order time derivative).

◆ explicit_jacobian_residual()

template<typename GO0 , typename GO1 , bool implicit = true>
void Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::explicit_jacobian_residual ( unsigned int  stage,
const std::vector< Domain * > &  x,
Jacobian &  a,
Range &  r1,
Range &  r0 
)
inline

Assemble jacobian and residual simultaneously for explicit treatment.

◆ fill_pattern()

template<typename GO0 , typename GO1 , bool implicit = true>
void Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::fill_pattern ( Pattern &  p) const
inline

Fill pattern of jacobian matrix.

◆ globalSizeU()

template<typename GO0 , typename GO1 , bool implicit = true>
Traits::TrialGridFunctionSpace::Traits::SizeType Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::globalSizeU ( ) const
inline

Get dimension of space u.

◆ globalSizeV()

template<typename GO0 , typename GO1 , bool implicit = true>
Traits::TestGridFunctionSpace::Traits::SizeType Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::globalSizeV ( ) const
inline

Get dimension of space v.

◆ interpolate()

template<typename GO0 , typename GO1 , bool implicit = true>
template<typename F , typename X >
void Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::interpolate ( unsigned  stage,
const X &  xold,
F &  f,
X &  x 
) const
inline

Interpolate constrained values from given function f.

◆ jacobian()

template<typename GO0 , typename GO1 , bool implicit = true>
void Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::jacobian ( const Domain &  x,
Jacobian &  a 
) const
inline

Assemble jacobian.

◆ jacobian_apply() [1/2]

template<typename GO0 , typename GO1 , bool implicit = true>
void Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::jacobian_apply ( const Domain &  solution,
const Domain &  update,
Range &  result 
) const
inline

Apply jacobian matrix to the vector update without explicitly assembling it.

◆ jacobian_apply() [2/2]

template<typename GO0 , typename GO1 , bool implicit = true>
void Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::jacobian_apply ( const Domain &  update,
Range &  result 
) const
inline

Apply jacobian matrix to the vector update without explicitly assembling it.

◆ localAssembler()

template<typename GO0 , typename GO1 , bool implicit = true>
LocalAssembler & Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::localAssembler ( ) const
inline

◆ make_consistent()

template<typename GO0 , typename GO1 , bool implicit = true>
void Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::make_consistent ( Jacobian &  a) const
inline

◆ matrixBackend()

template<typename GO0 , typename GO1 , bool implicit = true>
const Traits::MatrixBackend & Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::matrixBackend ( ) const
inline

◆ multiplySpatialTermByDeltaT()

template<typename GO0 , typename GO1 , bool implicit = true>
void Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::multiplySpatialTermByDeltaT ( )
inline

◆ postStage()

template<typename GO0 , typename GO1 , bool implicit = true>
void Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::postStage ( )
inline

to be called after stage is completed

◆ postStep()

template<typename GO0 , typename GO1 , bool implicit = true>
void Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::postStep ( )
inline

to be called after step is completed

◆ preStage()

template<typename GO0 , typename GO1 , bool implicit = true>
void Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::preStage ( unsigned int  stage,
const std::vector< Domain * > &  x 
)
inline

Assemble constant part of residual.

◆ preStep()

template<typename GO0 , typename GO1 , bool implicit = true>
void Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::preStep ( const TimeSteppingParameterInterface< Real > &  method_,
Real  time_,
Real  dt_ 
)
inline

parametrize assembler with a time-stepping method

◆ residual()

template<typename GO0 , typename GO1 , bool implicit = true>
void Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::residual ( const Domain &  x,
Range &  r 
) const
inline

Assemble residual.

◆ setMethod()

template<typename GO0 , typename GO1 , bool implicit = true>
void Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::setMethod ( const TimeSteppingParameterInterface< Real > &  method_)
inline

set time stepping method

◆ suggestTimestep()

template<typename GO0 , typename GO1 , bool implicit = true>
Real Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::suggestTimestep ( Real  dt) const
inline

to be called once before each stage

◆ testGridFunctionSpace()

template<typename GO0 , typename GO1 , bool implicit = true>
const Traits::TestGridFunctionSpace & Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::testGridFunctionSpace ( ) const
inline

Get the test grid function space.

◆ trialConstraints()

template<typename GO0 , typename GO1 , bool implicit = true>
const LocalAssembler::Traits::TrialGridFunctionSpaceConstraints Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::trialConstraints ( ) const
inline

◆ trialGridFunctionSpace()

template<typename GO0 , typename GO1 , bool implicit = true>
const Traits::TrialGridFunctionSpace & Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::trialGridFunctionSpace ( ) const
inline

Get the trial grid function space.

◆ update()

template<typename GO0 , typename GO1 , bool implicit = true>
void Dune::PDELab::OneStepGridOperator< GO0, GO1, implicit >::update ( )
inline
The documentation for this class was generated from the following file:
Legal Statements / Impressum   |  Hosted by TU Dresden & Uni Heidelberg  |  Generated by   doxygen 1.9.8