Inheritance diagram for LOP_spatial_flow< Param >:

Public Types
enum	{ doPatternVolume = true }

enum	{ doPatternSkeleton = true }

enum	{ doAlphaSkeleton = true }

enum	{ doAlphaBoundary = true }

typedef double	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
	LOP_spatial_flow (Param &param_)
	constructor stores a copy of the parameter object More...

void	setTime (RF t)

template<typename IG , typename LFSU , typename X , typename LFSV , typename R >
void	alpha_skeleton (const IG &ig, const LFSU &lfsu_i, const X &x_i, const LFSV &lfsv_i, const LFSU &lfsu_o, const X &x_o, const LFSV &lfsv_o, R &r_i, R &r_o) const
	residual contribution from skeleton terms More...

template<typename IG , typename LFSU , typename X , typename LFSV , typename R >
void	alpha_boundary (const IG &ig, const LFSU &lfsu_i, const X &x_i, const LFSV &lfsv_i, R &r_i) const

template<typename LFSU , typename LFSV , typename LocalPattern >
void	pattern_volume (const LFSU &lfsu, const LFSV &lfsv, LocalPattern &pattern) const

template<typename LFSU , typename LFSV , typename LocalPattern >
void	pattern_skeleton (const LFSU &lfsu_s, const LFSV &lfsv_s, const LFSU &lfsu_n, const LFSV &lfsv_n, LocalPattern &pattern_sn, LocalPattern &pattern_ns) const

void	jacobian_volume (const EG &eg, const LFSU &lfsu, const X &x, const LFSV &lfsv, Jacobian &mat) const
	compute local jacobian of the volume term More...

void	jacobian_skeleton (const IG &ig, const LFSU &lfsu_s, const X &x_s, const LFSV &lfsv_s, const LFSU &lfsu_n, const X &x_n, const LFSV &lfsv_n, Jacobian &mat_ss, Jacobian &mat_sn, Jacobian &mat_ns, Jacobian &mat_nn) const
	compute local jacobian of the skeleton term More...

void	jacobian_boundary (const IG &ig, const LFSU &lfsu_s, const X &x_s, const LFSV &lfsv_s, Jacobian &mat_ss) const
	compute local jacobian of the boundary term More...

void	setTime (double t_)
	set time for subsequent evaluation More...

double	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<typename Param>
class LOP_spatial_flow< Param >

a local operator for solving one-phase flow in porous medium (Richards equation) using cell-centered finite volume method. Van Genuchten-Mualem model is used for water retention curve and hydraulic permeability. Variable is water pressure p_w, \phi is porosity, \rho density, S_w saturation, \vec{g} gravity vector, and K permeability.

$\begin{align*} \partial_t (\phi S_w) + \mathrm{div} \left( -K(S_w) (\nabla p_w - \vec{g} \rho) \right) &=& 0 \ x \in \Omega \\ pw &=& pw_ini \ t=0 \\ pw \cdot \nu &=& 0 \ x \in \Gamma_N \\ K (\nabla pw - \vec{g}\rho) \cdot \nu &=& q_{inflow} \ x \in \Gamma_{inflow} \\ pw \leq 0, K(\nabla pw -\vec{g}\rho) \cdot \nu &\leq& 0, pw \left(K(\nabla pw -\vec{g}\rho) \cdot \nu\right) = 0 \ x \in \Gamma_{free outflow} \end{align*}$

Examples: recipe-operator-splitting.cc.

Member Typedef Documentation

◆ RealType

typedef double Dune::PDELab::InstationaryLocalOperatorDefaultMethods< double >::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

◆ anonymous enum

template<typename Param >

anonymous enum

Enumerator
doPatternVolume

◆ anonymous enum

template<typename Param >

anonymous enum

Enumerator
doPatternSkeleton

◆ anonymous enum

template<typename Param >

anonymous enum

Enumerator
doAlphaSkeleton

◆ anonymous enum

template<typename Param >

anonymous enum

Enumerator
doAlphaBoundary

Constructor & Destructor Documentation

◆ LOP_spatial_flow()

template<typename Param >

LOP_spatial_flow< Param >::LOP_spatial_flow ( Param & param_ )

inline

constructor stores a copy of the parameter object

Examples: recipe-operator-splitting.cc.

Member Function Documentation

◆ alpha_boundary()

template<typename Param >

template<typename IG , typename LFSU , typename X , typename LFSV , typename R >

void LOP_spatial_flow< Param >::alpha_boundary	(	const IG &	ig,
		const LFSU &	lfsu_i,
		const X &	x_i,
		const LFSV &	lfsv_i,
		R &	r_i
	)		const

inline

Examples: recipe-operator-splitting.cc.

◆ alpha_skeleton()

template<typename Param >

template<typename IG , typename LFSU , typename X , typename LFSV , typename R >

void LOP_spatial_flow< Param >::alpha_skeleton	(	const IG &	ig,
		const LFSU &	lfsu_i,
		const X &	x_i,
		const LFSV &	lfsv_i,
		const LFSU &	lfsu_o,
		const X &	x_o,
		const LFSV &	lfsv_o,
		R &	r_i,
		R &	r_o
	)		const

inline

residual contribution from skeleton terms

Examples: recipe-operator-splitting.cc.

◆ getStage()

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

inlineinherited

get current stage

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

◆ getTime()

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

inlineinherited

get current time

Returns: The time previously set by setTime().

◆ jacobian_boundary()

void Dune::PDELab::NumericalJacobianBoundary< LOP_spatial_flow< Param > >::jacobian_boundary	(	const IG &	ig,
		const LFSU &	lfsu_s,
		const X &	x_s,
		const LFSV &	lfsv_s,
		Jacobian &	mat_ss
	)		const

inlineinherited

compute local jacobian of the boundary term

◆ jacobian_skeleton()

void Dune::PDELab::NumericalJacobianSkeleton< LOP_spatial_flow< Param > >::jacobian_skeleton	(	const IG &	ig,
		const LFSU &	lfsu_s,
		const X &	x_s,
		const LFSV &	lfsv_s,
		const LFSU &	lfsu_n,
		const X &	x_n,
		const LFSV &	lfsv_n,
		Jacobian &	mat_ss,
		Jacobian &	mat_sn,
		Jacobian &	mat_ns,
		Jacobian &	mat_nn
	)		const

inlineinherited

compute local jacobian of the skeleton term

◆ jacobian_volume()

void Dune::PDELab::NumericalJacobianVolume< LOP_spatial_flow< Param > >::jacobian_volume	(	const EG &	eg,
		const LFSU &	lfsu,
		const X &	x,
		const LFSV &	lfsv,
		Jacobian &	mat
	)		const

inlineinherited

compute local jacobian of the volume term

◆ pattern_skeleton()

template<typename LFSU , typename LFSV , typename LocalPattern >

void Dune::PDELab::FullSkeletonPattern::pattern_skeleton	(	const LFSU &	lfsu_s,
		const LFSV &	lfsv_s,
		const LFSU &	lfsu_n,
		const LFSV &	lfsv_n,
		LocalPattern &	pattern_sn,
		LocalPattern &	pattern_ns
	)		const

inlineinherited

◆ pattern_volume()

template<typename LFSU , typename LFSV , typename LocalPattern >

void Dune::PDELab::FullVolumePattern::pattern_volume	(	const LFSU &	lfsu,
		const LFSV &	lfsv,
		LocalPattern &	pattern
	)		const

inlineinherited

◆ postStage()

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

inlineinherited

to be called once at the end of each stage

◆ postStep()

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

◆ setTime() [1/2]

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

◆ setTime() [2/2]

template<typename Param >

void LOP_spatial_flow< Param >::setTime ( RF t )

inline

Examples: recipe-operator-splitting.cc.

◆ suggestTimestep()

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

recipe-operator-splitting.cc

Public Types

Public Member Functions

Detailed Description

template<typename Param> class LOP_spatial_flow< Param >

Member Typedef Documentation

◆ RealType

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ LOP_spatial_flow()

Member Function Documentation

◆ alpha_boundary()

◆ alpha_skeleton()

◆ getStage()

◆ getTime()

◆ jacobian_boundary()

◆ jacobian_skeleton()

◆ jacobian_volume()

◆ pattern_skeleton()

◆ pattern_volume()

◆ postStage()

◆ postStep()

◆ preStage()

◆ preStep()

◆ setTime() [1/2]

◆ setTime() [2/2]

◆ suggestTimestep()

template<typename Param>
class LOP_spatial_flow< Param >