Local operator for the vector wave problem, one-temporal-derivative part. More...

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

Inheritance diagram for Dune::PDELab::VectorWave::R1< Params >:

Public Types
typedef Params::Time	RealType

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...

Public Member Functions
	R1 (Params &params_, std::size_t qorder_=0)
	Construct a local operator object. More...

void	setTime (Params::Timet_)
	set time for subsequent evaluation More...

Params::Time	getTime () const
	get current time More...

void	preStep (RealType time, RealType dt, int stages)
	to be called once before each time step More...

void	postStep ()
	to be called once at the end of each time step More...

void	preStage (RealType time, int r)
	to be called once before each stage More...

int	getStage () const
	get current stage More...

void	postStage ()
	to be called once at the end of each stage More...

RealType	suggestTimestep (RealType dt) const
	to be called after stage 1 More...

Detailed Description

template<class Params>
class Dune::PDELab::VectorWave::R1< Params >

Local operator for the vector wave problem, one-temporal-derivative part.

The vector-wave equation in its simplest form:

$\partial_t^2(\varepsilon\mathbf E) +\nabla\times\mu^{-1}\nabla\times\mathbf E = 0$

This local operator implements the part with one temporal derivatives

$0$

Yes there is no part with only one temporal derivate in the above equation, so this local operator is a dummy which implements nothing.

Template Parameters

Params Type of parameter class as for the other local operators. For consistency mostly.

Member Typedef Documentation

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

inherited

Member Enumeration Documentation

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

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

inherited

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

Enumerator
doPatternSkeleton

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

inherited

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

Enumerator
doAlphaVolume

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

inherited

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

Enumerator
doAlphaSkeleton

anonymous enum

inherited

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

Enumerator
doAlphaBoundary

anonymous enum

inherited

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

Enumerator
doLambdaVolume

anonymous enum

inherited

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

Enumerator
doLambdaVolumePostSkeleton

anonymous enum

inherited

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

Enumerator
doLambdaSkeleton

anonymous enum

inherited

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

Enumerator
doLambdaBoundary

anonymous enum

inherited

Whether to visit the skeleton methods from both sides.

Enumerator
doSkeletonTwoSided

Constructor & Destructor Documentation

template<class Params >

Dune::PDELab::VectorWave::R1< Params >::R1	(	Params &	params_,
		std::size_t	qorder_ = `0`
	)

inline

Construct a local operator object.

Parameters

params_	Parameter object providing values for $\mu$ .
qorder_	Quadrature order to use.

Note: This constructor does nothing and is present for consistency only.

Member Function Documentation

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

inlineinherited

get current stage

Returns: The current stage number previously set by preStage().

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

inlineinherited

get current time

Returns: The time previously set by setTime().

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

inlineinherited

to be called once at the end of each stage

void Dune::PDELab::InstationaryLocalOperatorDefaultMethods< Params::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.

void Dune::PDELab::InstationaryLocalOperatorDefaultMethods< Params::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.

void Dune::PDELab::InstationaryLocalOperatorDefaultMethods< Params::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

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.

void Dune::PDELab::InstationaryLocalOperatorDefaultMethods< Params::Time >::setTime ( Params::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.

RealType Dune::PDELab::InstationaryLocalOperatorDefaultMethods< Params::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:

vectorwave.hh

Public Types

Public Member Functions

Detailed Description

template<class Params> class Dune::PDELab::VectorWave::R1< Params >

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<class Params>
class Dune::PDELab::VectorWave::R1< Params >