Dune::PDELab::ZeroLocalOperator< Time > Class Template Reference

Do-nothing local operator. More...

#include <dune/pdelab/localoperator/zero.hh>

Inheritance diagram for Dune::PDELab::ZeroLocalOperator< Time >:

Public Types
typedef Time	RealType
Flags selective assembly
enum	{ doSkipEntity }
	Whether to do selective assembly on the elements, i.e. whether or not skip_entity() should be called. More...
enum	{ doSkipIntersection }
	Whether to do selective assembly on the intersections, i.e. whether or not skip_intersection() should be called. More...
Flags for the sparsity pattern
enum	{ doPatternVolume }
	Whether to assemble the pattern on the elements, i.e. whether or not pattern_volume() should be called. More...
enum	{ doPatternVolumePostSkeleton }
	Whether to assemble the pattern on the elements after the skeleton has been handled, i.e. whether or not pattern_volume_post_skeleton() should be called. More...
enum	{ doPatternSkeleton }
	Whether to assemble the pattern on the interior intersections, i.e. whether or not pattern_skeleton() should be called. More...
enum	{ doPatternBoundary }
	Whether to assemble the pattern on the boundary intersections, i.e. whether or not pattern_boundary() should be called. More...
Flags for the non-constant part of the residual and the jacobian
enum	{ doAlphaVolume }
	Whether to call the local operator's alpha_volume(), jacobian_apply_volume() and jacobian_volume(). More...
enum	{ doAlphaVolumePostSkeleton }
	Whether to call the local operator's alpha_volume_post_skeleton(), jacobian_apply_volume_post_skeleton() and jacobian_volume_post_skeleton(). More...
enum	{ doAlphaSkeleton }
	Whether to call the local operator's alpha_skeleton(), jacobian_apply_skeleton() and jacobian_skeleton(). More...
enum	{ doAlphaBoundary }
	Whether to call the local operator's alpha_boundary(), jacobian_apply_boundary() and jacobian_boundary(). More...
Flags for the constant part of the residual
enum	{ doLambdaVolume }
	Whether to call the local operator's lambda_volume(). More...
enum	{ doLambdaVolumePostSkeleton }
	Whether to call the local operator's lambda_volume_post_skeleton(). More...
enum	{ doLambdaSkeleton }
	Whether to call the local operator's lambda_skeleton(). More...
enum	{ doLambdaBoundary }
	Whether to call the local operator's lambda_boundary(). More...
Special flags
enum	{ doSkeletonTwoSided }
	Whether to visit the skeleton methods from both sides. More...
enum	{ isLinear }
	Wheter the local operator describes a linear problem. More...

Public Member Functions
void	setTime (Time t_)
	set time for subsequent evaluation
Time	getTime () const
	get current time
void	preStep (RealType time, RealType dt, int stages)
	to be called once before each time step
void	postStep ()
	to be called once at the end of each time step
void	preStage (RealType time, int r)
	to be called once before each stage
int	getStage () const
	get current stage
void	postStage ()
	to be called once at the end of each stage
RealType	suggestTimestep (RealType dt) const
	to be called after stage 1

Detailed Description

template<class Time>
class Dune::PDELab::ZeroLocalOperator< Time >

Do-nothing local operator.

This local operator does nothing. It can be used as a placeholder where an (instationary) local operator is semantically required but not actually used.

Template Parameters

Time	Type used for temporal values.

Member Typedef Documentation

RealType

typedef Time Dune::PDELab::InstationaryLocalOperatorDefaultMethods< Time >::RealType

inherited

Member Enumeration Documentation

anonymous enum

anonymous enum

inherited

Whether to do selective assembly on the elements, i.e. whether or not skip_entity() should be called.

Enumerator
doSkipEntity

anonymous enum

anonymous enum

inherited

Whether to do selective assembly on the intersections, i.e. whether or not skip_intersection() should be called.

Enumerator
doSkipIntersection

anonymous enum

anonymous enum

inherited

Whether to assemble the pattern on the elements, i.e. whether or not pattern_volume() should be called.

Enumerator
doPatternVolume

anonymous enum

anonymous enum

inherited

Whether to assemble the pattern on the elements after the skeleton has been handled, i.e. whether or not pattern_volume_post_skeleton() should be called.

Enumerator
doPatternVolumePostSkeleton

anonymous enum

anonymous enum

inherited

Whether to assemble the pattern on the interior intersections, i.e. whether or not pattern_skeleton() should be called.

Enumerator
doPatternSkeleton

anonymous enum

anonymous enum

inherited

Whether to assemble the pattern on the boundary intersections, i.e. whether or not pattern_boundary() should be called.

Enumerator
doPatternBoundary

anonymous enum

anonymous enum

inherited

Whether to call the local operator's alpha_volume(), jacobian_apply_volume() and jacobian_volume().

Enumerator
doAlphaVolume

anonymous enum

anonymous enum

inherited

Whether to call the local operator's alpha_volume_post_skeleton(), jacobian_apply_volume_post_skeleton() and jacobian_volume_post_skeleton().

Enumerator
doAlphaVolumePostSkeleton

anonymous enum

anonymous enum

inherited

Whether to call the local operator's alpha_skeleton(), jacobian_apply_skeleton() and jacobian_skeleton().

Enumerator
doAlphaSkeleton

anonymous enum

anonymous enum

inherited

Whether to call the local operator's alpha_boundary(), jacobian_apply_boundary() and jacobian_boundary().

Enumerator
doAlphaBoundary

anonymous enum

anonymous enum

inherited

Whether to call the local operator's lambda_volume().

Enumerator
doLambdaVolume

anonymous enum

anonymous enum

inherited

Whether to call the local operator's lambda_volume_post_skeleton().

Enumerator
doLambdaVolumePostSkeleton

anonymous enum

anonymous enum

inherited

Whether to call the local operator's lambda_skeleton().

Enumerator
doLambdaSkeleton

anonymous enum

anonymous enum

inherited

Whether to call the local operator's lambda_boundary().

Enumerator
doLambdaBoundary

anonymous enum

anonymous enum

inherited

Whether to visit the skeleton methods from both sides.

Enumerator
doSkeletonTwoSided

anonymous enum

anonymous enum

inherited

Wheter the local operator describes a linear problem.

Enumerator
isLinear

Member Function Documentation

getStage()

int Dune::PDELab::InstationaryLocalOperatorDefaultMethods< Time >::getStage ( ) const

inlineinherited

get current stage

Returns

The current stage number previously set by preStage().

getTime()

Time Dune::PDELab::InstationaryLocalOperatorDefaultMethods< Time >::getTime ( ) const

inlineinherited

get current time

Returns

The time previously set by setTime().

postStage()

void Dune::PDELab::InstationaryLocalOperatorDefaultMethods< Time >::postStage ( )

inlineinherited

to be called once at the end of each stage

postStep()

void Dune::PDELab::InstationaryLocalOperatorDefaultMethods< Time >::postStep ( )

inlineinherited

to be called once at the end of each time step

Note

With the OneStepMethod and the ExplicitOneStepMetod, for reasons unknown this is only called for temporal but not for spatial local operators. With the MultiStepMethod this is called for all local operators.

preStage()

void Dune::PDELab::InstationaryLocalOperatorDefaultMethods< Time >::preStage ( RealType  time, int  r  )

inlineinherited

to be called once before each stage

Parameters

time	Time of the stage
r	Number of the stage, r ∈ [1, nstages] inclusive, where nstages is the number of stage in the step given in the previous call to preStep()

Note

For ExplicitOneStepMethod the time given here for stage 1 may be incorrect, since the time step size is only finally determined after the first stage has been assembled.

For the MultiStepMethod, this is called once after preStep() with r=1.

preStep()

void Dune::PDELab::InstationaryLocalOperatorDefaultMethods< Time >::preStep ( RealType  time, RealType  dt, int  stages  )

inlineinherited

to be called once before each time step

Parameters

time	Time at beginning of the step.
dt	Size of time step.
stages	Number of stages to do in the step. For the MultiStepMethod this is always 1.

Note

For ExplicitOneStepMethod the dt given here may be incorrect, since the time step size is only finally determined after the first stage has been assembled.

For the MultiStepMethod the number of stages is given as

1. Since there are no times of evaluation in the middle of the step, a multi-step method is similar to a one step method with one stage.

setTime()

void Dune::PDELab::InstationaryLocalOperatorDefaultMethods< Time >::setTime ( Time  t_ )

inlineinherited

set time for subsequent evaluation

This method set the time for subsequent calls to the alpha_*(), lambda_*(), jacobian_*() and jacobian_apply_*() methods.

Note

For ExplicitOneStepMethod the time given here in the first stage may be incorrect, since the time step size is only finally determined after the first stage has been assembled.

suggestTimestep()

RealType Dune::PDELab::InstationaryLocalOperatorDefaultMethods< Time >::suggestTimestep ( RealType  dt ) const

inlineinherited

to be called after stage 1

Note

Only used by the ExplicitOneStepMethod.

This may be called on the spatial local operator in the case of an explicit one step scheme. It is called after stage 1 has been assembled (so the time given to preStep() may not apply anymore in this case). All the alpha_*() and lambda_*() methods should have been called, so they are a good place to generate the information returned here.

---

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

• zero.hh