Base class for stationary solution of a two-phase diffusion/pressure equation. More...

#include <dumux/porousmediumflow/2p/sequential/diffusion/problem.hh>

Inheritance diagram for Dumux::DiffusionProblem2P< TypeTag >:

Description

template<class TypeTag>
class Dumux::DiffusionProblem2P< TypeTag >

Base class for stationary solution of a two-phase diffusion/pressure equation.

Template Parameters

TypeTag The problem TypeTag

Public Member Functions
	DiffusionProblem2P (TimeManager &timeManager, Grid &grid)
	Constructs a DiffusionProblem2P object. More...

	DiffusionProblem2P (TimeManager &timeManager, Grid &grid, SpatialParams &spatialParams)
	Constructs a DiffusionProblem2P object. More...

	DiffusionProblem2P (Grid &grid)
	Constructs a DiffusionProblem2P object. More...

	DiffusionProblem2P (Grid &grid, SpatialParams &spatialParams)
	Constructs a DiffusionProblem2P object. More...

void	boundaryTypes (BoundaryTypes &bcTypes, const Intersection &intersection) const
	Specifies which kind of boundary condition should be used for which equation on a given boundary segment. More...

void	boundaryTypesAtPos (BoundaryTypes &bcTypes, const GlobalPosition &globalPos) const
	Specifies which kind of boundary condition should be used for which equation on a given boundary segment. More...

void	dirichlet (PrimaryVariables &values, const Intersection &intersection) const
	Evaluate the boundary conditions for a dirichlet control volume. More...

void	dirichletAtPos (PrimaryVariables &values, const GlobalPosition &globalPos) const
	Evaluate the boundary conditions for a dirichlet control volume. More...

void	neumann (PrimaryVariables &values, const Intersection &intersection) const
	Evaluate the boundary conditions for a neumann boundary segment. More...

void	neumannAtPos (PrimaryVariables &values, const GlobalPosition &globalPos) const
	Evaluate the boundary conditions for a neumann boundary segment. More...

void	source (PrimaryVariables &values, const Element &element) const
	Evaluate the source term. More...

void	sourceAtPos (PrimaryVariables &values, const GlobalPosition &globalPos) const
	Evaluate the source term for all phases within a given sub-control-volume. More...

void	initial (PrimaryVariables &values, const Element &element) const
	Evaluate the initial value for a control volume. More...

void	initialAtPos (PrimaryVariables &values, const GlobalPosition &globalPos) const
	Evaluate the initial value for a control volume. More...

void	init ()
	Called by the TimeManager in order to initialize the problem. More...

void	preTimeStep ()
	Called by TimeManager just before the time integration. More...

void	postTimeStep ()
	Called by TimeManager whenever a solution for a timestep has been computed and the simulation time has been updated. More...

void	advanceTimeLevel ()
	Called by the time manager after everything which can be done about the current time step is finished and the model should be prepared to do the next time integration. More...

Scalar	maxTimeStepSize () const
	Returns the user specified maximum time step size. More...

Scalar	timeStepSize () const
	Returns the current time step size [seconds]. More...

void	setTimeStepSize (Scalar dt)
	Sets the current time step size [seconds]. More...

Scalar	nextTimeStepSize (Scalar dt)
	Called by TimeManager whenever a solution for a timestep has been computed and the simulation time has been updated. More...

bool	shouldWriteRestartFile () const
	Returns true if a restart file should be written to disk. More...

void	setOutputTimeInterval (const Scalar timeInterval)
	Sets a time interval for Output. More...

void	setOutputInterval (int interval)
	Sets the interval for Output. More...

bool	shouldWriteOutput () const
	Returns true if the current solution should be written to disk (i.e. as a VTK file) More...

void	addOutputVtkFields ()

void	writeOutput (bool verbose=true)
	Write the fields current solution into an VTK output file. More...

void	episodeEnd ()
	Called when the end of an simulation episode is reached. More...

const std::string &	name () const
	The problem name. More...

void	setName (const std::string &newName)
	Set the problem name. More...

const GridView &	gridView () const
	The GridView which used by the problem. More...

const VertexMapper &	vertexMapper () const
	Returns the mapper for vertices to indices. More...

const ElementMapper &	elementMapper () const
	Returns the mapper for elements to indices. More...

const GlobalPosition &	bBoxMin () const
	The coordinate of the corner of the GridView's bounding box with the smallest values. More...

const GlobalPosition &	bBoxMax () const
	The coordinate of the corner of the GridView's bounding box with the largest values. More...

TimeManager &	timeManager ()
	Returns TimeManager object used by the simulation. More...

const TimeManager &	timeManager () const
	Returns TimeManager object used by the simulation. More...

Variables &	variables ()
	Returns variables object. More...

const Variables &	variables () const
	Returns variables object. More...

Model &	model ()
	Returns numerical model used for the problem. More...

const Model &	model () const
	Returns numerical model used for the problem. More...

Problem parameters
void	timeIntegration ()
	Time integration function called by the time manager. More...

Scalar	temperature (const Element &element) const
	Returns the temperature within the domain. More...

Scalar	temperatureAtPos (const GlobalPosition &globalPos) const
	Returns the temperature within the domain. More...

Scalar	referencePressure (const Element &element) const
	Returns the reference pressure for evaluation of constitutive relations. More...

Scalar	referencePressureAtPos (const GlobalPosition &globalPos) const
	Returns the reference pressure for evaluation of constitutive relations. More...

const GravityVector &	gravity () const
	Returns the acceleration due to gravity. More...

SpatialParams &	spatialParams ()
	Returns the spatial parameters object. More...

const SpatialParams &	spatialParams () const
	Returns the spatial parameters object. More...

PressureModel &	pressureModel ()
	Returns the pressure model used for the problem. More...

const PressureModel &	pressureModel () const
	Returns the pressure model used for the problem. // TODO doc me! More...

Restart mechanism
void	serialize ()
	This method writes the complete state of the problem to the harddisk. More...

void	restart (double tRestart)
	This method restores the complete state of the problem from disk. More...

VtkMultiWriter &	resultWriter ()

VtkMultiWriter &	resultWriter () const

Constructor & Destructor Documentation

◆ DiffusionProblem2P() [1/4]

template<class TypeTag >

Dumux::DiffusionProblem2P< TypeTag >::DiffusionProblem2P	(	TimeManager &	timeManager,
		Grid &	grid
	)

inline

Constructs a DiffusionProblem2P object.

Parameters

timeManager	the time manager
grid	The grid

◆ DiffusionProblem2P() [2/4]

template<class TypeTag >

Dumux::DiffusionProblem2P< TypeTag >::DiffusionProblem2P	(	TimeManager &	timeManager,
		Grid &	grid,
		SpatialParams &	spatialParams
	)

inline

Constructs a DiffusionProblem2P object.

Parameters

timeManager	the time manager
grid	The grid
spatialParams	SpatialParams instantiation

◆ DiffusionProblem2P() [3/4]

template<class TypeTag >

Dumux::DiffusionProblem2P< TypeTag >::DiffusionProblem2P ( Grid & grid )

inline

Constructs a DiffusionProblem2P object.

Parameters

grid The grid

◆ DiffusionProblem2P() [4/4]

template<class TypeTag >

Dumux::DiffusionProblem2P< TypeTag >::DiffusionProblem2P	(	Grid &	grid,
		SpatialParams &	spatialParams
	)

inline

Constructs a DiffusionProblem2P object.

Parameters

grid	The grid
spatialParams	SpatialParams instantiation

Member Function Documentation

◆ addOutputVtkFields()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::addOutputVtkFields ( )

inlineinherited

◆ advanceTimeLevel()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::advanceTimeLevel ( )

inlineinherited

Called by the time manager after everything which can be done about the current time step is finished and the model should be prepared to do the next time integration.

◆ bBoxMax()

template<class TypeTag >

const GlobalPosition & Dumux::OneModelProblem< TypeTag >::bBoxMax ( ) const

inlineinherited

The coordinate of the corner of the GridView's bounding box with the largest values.

◆ bBoxMin()

template<class TypeTag >

const GlobalPosition & Dumux::OneModelProblem< TypeTag >::bBoxMin ( ) const

inlineinherited

The coordinate of the corner of the GridView's bounding box with the smallest values.

◆ boundaryTypes()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::boundaryTypes	(	BoundaryTypes &	bcTypes,
		const Intersection &	intersection
	)		const

inlineinherited

Specifies which kind of boundary condition should be used for which equation on a given boundary segment.

Parameters

bcTypes	The boundary types for the conservation equations
intersection	The intersection for which the boundary type is set

◆ boundaryTypesAtPos()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::boundaryTypesAtPos	(	BoundaryTypes &	bcTypes,
		const GlobalPosition &	globalPos
	)		const

inlineinherited

Specifies which kind of boundary condition should be used for which equation on a given boundary segment.

Parameters

bcTypes	The boundary types for the conservation equations
globalPos	The position of the center of the boundary intersection

◆ dirichlet()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::dirichlet	(	PrimaryVariables &	values,
		const Intersection &	intersection
	)		const

inlineinherited

Evaluate the boundary conditions for a dirichlet control volume.

Parameters

values	The dirichlet values for the primary variables
intersection	The boundary intersection

For this method, the values parameter stores primary variables.

◆ dirichletAtPos()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::dirichletAtPos	(	PrimaryVariables &	values,
		const GlobalPosition &	globalPos
	)		const

inlineinherited

Evaluate the boundary conditions for a dirichlet control volume.

Parameters

values	The dirichlet values for the primary variables
globalPos	The position of the center of the boundary intersection

For this method, the values parameter stores primary variables.

◆ elementMapper()

template<class TypeTag >

const ElementMapper & Dumux::OneModelProblem< TypeTag >::elementMapper ( ) const

inlineinherited

Returns the mapper for elements to indices.

◆ episodeEnd()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::episodeEnd ( )

inlineinherited

Called when the end of an simulation episode is reached.

◆ gravity()

template<class TypeTag >

const GravityVector & Dumux::DiffusionProblem2P< TypeTag >::gravity ( ) const

inline

Returns the acceleration due to gravity.

If the EnableGravity property is true, this means \(\boldsymbol{g} = ( 0,\dots,\ -9.81)^T \), else \(\boldsymbol{g} = ( 0,\dots, 0)^T \)

◆ gridView()

template<class TypeTag >

const GridView & Dumux::OneModelProblem< TypeTag >::gridView ( ) const

inlineinherited

The GridView which used by the problem.

◆ init()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::init ( )

inlineinherited

Called by the TimeManager in order to initialize the problem.

◆ initial()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::initial	(	PrimaryVariables &	values,
		const Element &	element
	)		const

inlineinherited

Evaluate the initial value for a control volume.

Parameters

values	The initial values for the primary variables
element	The element

For this method, the values parameter stores primary variables.

◆ initialAtPos()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::initialAtPos	(	PrimaryVariables &	values,
		const GlobalPosition &	globalPos
	)		const

inlineinherited

Evaluate the initial value for a control volume.

Parameters

values	The dirichlet values for the primary variables
globalPos	The position of the center of the finite volume for which the initial values ought to be set (in global coordinates)

For this method, the values parameter stores primary variables.

◆ maxTimeStepSize()

template<class TypeTag >

Scalar Dumux::OneModelProblem< TypeTag >::maxTimeStepSize ( ) const

inlineinherited

Returns the user specified maximum time step size.

Overload in problem for custom needs.

◆ model() [1/2]

template<class TypeTag >

Model & Dumux::OneModelProblem< TypeTag >::model ( )

inlineinherited

Returns numerical model used for the problem.

◆ model() [2/2]

template<class TypeTag >

const Model & Dumux::OneModelProblem< TypeTag >::model ( ) const

inlineinherited

Returns numerical model used for the problem.

◆ name()

template<class TypeTag >

const std::string & Dumux::OneModelProblem< TypeTag >::name ( ) const

inlineinherited

The problem name.

This is used as a prefix for files generated by the simulation. It could be either overwritten by the problem files, or simply declared over the setName() function in the application file.

◆ neumann()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::neumann	(	PrimaryVariables &	values,
		const Intersection &	intersection
	)		const

inlineinherited

Evaluate the boundary conditions for a neumann boundary segment.

Parameters

values	The neumann values for the conservation equations [kg / (m^2 *s )]
intersection	The boundary intersection

For this method, the values parameter stores the mass flux in normal direction of each phase. Negative values mean influx.

◆ neumannAtPos()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::neumannAtPos	(	PrimaryVariables &	values,
		const GlobalPosition &	globalPos
	)		const

inlineinherited

Evaluate the boundary conditions for a neumann boundary segment.

Parameters

values	The neumann values for the conservation equations [kg / (m^2 *s )]
globalPos	The position of the center of the boundary intersection

For this method, the values parameter stores the mass flux in normal direction of each phase. Negative values mean influx.

◆ nextTimeStepSize()

template<class TypeTag >

Scalar Dumux::OneModelProblem< TypeTag >::nextTimeStepSize ( Scalar dt )

inlineinherited

Called by TimeManager whenever a solution for a timestep has been computed and the simulation time has been updated.

◆ postTimeStep()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::postTimeStep ( )

inlineinherited

Called by TimeManager whenever a solution for a timestep has been computed and the simulation time has been updated.

This is used to do some janitorial tasks like writing the current solution to disk.

◆ pressureModel() [1/2]

template<class TypeTag >

PressureModel & Dumux::DiffusionProblem2P< TypeTag >::pressureModel ( )

inline

Returns the pressure model used for the problem.

◆ pressureModel() [2/2]

template<class TypeTag >

const PressureModel & Dumux::DiffusionProblem2P< TypeTag >::pressureModel ( ) const

inline

Returns the pressure model used for the problem. // TODO doc me!

// TODO doc me!

◆ preTimeStep()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::preTimeStep ( )

inlineinherited

Called by TimeManager just before the time integration.

◆ referencePressure()

template<class TypeTag >

Scalar Dumux::DiffusionProblem2P< TypeTag >::referencePressure ( const Element & element ) const

inline

Returns the reference pressure for evaluation of constitutive relations.

Parameters

element The element

◆ referencePressureAtPos()

template<class TypeTag >

Scalar Dumux::DiffusionProblem2P< TypeTag >::referencePressureAtPos ( const GlobalPosition & globalPos ) const

inline

Returns the reference pressure for evaluation of constitutive relations.

Parameters

globalPos The position of the center of an element

◆ restart()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::restart ( double tRestart )

inlineinherited

This method restores the complete state of the problem from disk.

It is the inverse of the serialize() method.

◆ resultWriter() [1/2]

template<class TypeTag >

VtkMultiWriter & Dumux::OneModelProblem< TypeTag >::resultWriter ( )

inlineprotectedinherited

◆ resultWriter() [2/2]

template<class TypeTag >

VtkMultiWriter & Dumux::OneModelProblem< TypeTag >::resultWriter ( ) const

inlineprotectedinherited

◆ serialize()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::serialize ( )

inlineinherited

This method writes the complete state of the problem to the harddisk.

The file will start with the prefix returned by the name() method, has the current time of the simulation clock in it's name and uses the extension .drs. (Dumux ReStart file.) See Restart for details.

◆ setName()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::setName ( const std::string & newName )

inlineinherited

Set the problem name.

This function sets the simulation name, which should be called before the application problem is declared! If not, the default name "sim" will be used.

◆ setOutputInterval()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::setOutputInterval ( int interval )

inlineinherited

Sets the interval for Output.

The default is 1 -> Output every time step

◆ setOutputTimeInterval()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::setOutputTimeInterval ( const Scalar timeInterval )

inlineinherited

Sets a time interval for Output.

The default is 0.0 -> Output determined by output number interval (setOutputInterval(int))

◆ setTimeStepSize()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::setTimeStepSize ( Scalar dt )

inlineinherited

Sets the current time step size [seconds].

◆ shouldWriteOutput()

template<class TypeTag >

bool Dumux::OneModelProblem< TypeTag >::shouldWriteOutput ( ) const

inlineinherited

Returns true if the current solution should be written to disk (i.e. as a VTK file)

The default behaviour is to write out every the solution for very time step. This file is intented to be overwritten by the implementation.

◆ shouldWriteRestartFile()

template<class TypeTag >

bool Dumux::OneModelProblem< TypeTag >::shouldWriteRestartFile ( ) const

inlineinherited

Returns true if a restart file should be written to disk.

The default behaviour is to write one restart file every 5 time steps. This file is intented to be overwritten by the implementation.

◆ source()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::source	(	PrimaryVariables &	values,
		const Element &	element
	)		const

inlineinherited

Evaluate the source term.

Parameters

values	The source and sink values for the conservation equations
element	The element

For this method, the values parameter stores the rate mass generated or annihilate per volume unit. Positive values mean that mass is created, negative ones mean that it vanishes.

◆ sourceAtPos()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::sourceAtPos	(	PrimaryVariables &	values,
		const GlobalPosition &	globalPos
	)		const

inlineinherited

Evaluate the source term for all phases within a given sub-control-volume.

Parameters

values	The source and sink values for the conservation equations
globalPos	The position of the center of the finite volume for which the source term ought to be specified in global coordinates

For this method, the values parameter stores the rate mass generated or annihilate per volume unit. Positive values mean that mass is created, negative ones mean that it vanishes.

◆ spatialParams() [1/2]

template<class TypeTag >

SpatialParams & Dumux::DiffusionProblem2P< TypeTag >::spatialParams ( )

inline

Returns the spatial parameters object.

◆ spatialParams() [2/2]

template<class TypeTag >

const SpatialParams & Dumux::DiffusionProblem2P< TypeTag >::spatialParams ( ) const

inline

Returns the spatial parameters object.

◆ temperature()

template<class TypeTag >

Scalar Dumux::DiffusionProblem2P< TypeTag >::temperature ( const Element & element ) const

inline

Returns the temperature within the domain.

Parameters

element The element

◆ temperatureAtPos()

template<class TypeTag >

Scalar Dumux::DiffusionProblem2P< TypeTag >::temperatureAtPos ( const GlobalPosition & globalPos ) const

inline

Returns the temperature within the domain.

Parameters

globalPos The position of the center of an element

◆ timeIntegration()

template<class TypeTag >

void Dumux::DiffusionProblem2P< TypeTag >::timeIntegration ( )

inline

Time integration function called by the time manager.

For stationary diffusion problems this function just finishes the simulation.

◆ timeManager() [1/2]

template<class TypeTag >

TimeManager & Dumux::OneModelProblem< TypeTag >::timeManager ( )

inlineinherited

Returns TimeManager object used by the simulation.

◆ timeManager() [2/2]

template<class TypeTag >

const TimeManager & Dumux::OneModelProblem< TypeTag >::timeManager ( ) const

inlineinherited

Returns TimeManager object used by the simulation.

◆ timeStepSize()

template<class TypeTag >

Scalar Dumux::OneModelProblem< TypeTag >::timeStepSize ( ) const

inlineinherited

Returns the current time step size [seconds].

◆ variables() [1/2]

template<class TypeTag >

Variables & Dumux::OneModelProblem< TypeTag >::variables ( )

inlineinherited

Returns variables object.

◆ variables() [2/2]

template<class TypeTag >

const Variables & Dumux::OneModelProblem< TypeTag >::variables ( ) const

inlineinherited

Returns variables object.

◆ vertexMapper()

template<class TypeTag >

const VertexMapper & Dumux::OneModelProblem< TypeTag >::vertexMapper ( ) const

inlineinherited

Returns the mapper for vertices to indices.

◆ writeOutput()

template<class TypeTag >

void Dumux::OneModelProblem< TypeTag >::writeOutput ( bool verbose = true )

inlineinherited

Write the fields current solution into an VTK output file.

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

porousmediumflow/2p/sequential/diffusion/problem.hh

Description

Public Member Functions

Problem parameters

Restart mechanism

Constructor & Destructor Documentation

◆ DiffusionProblem2P() [1/4]

◆ DiffusionProblem2P() [2/4]

◆ DiffusionProblem2P() [3/4]

◆ DiffusionProblem2P() [4/4]

Member Function Documentation

◆ addOutputVtkFields()

◆ advanceTimeLevel()

◆ bBoxMax()

◆ bBoxMin()

◆ boundaryTypes()

◆ boundaryTypesAtPos()

◆ dirichlet()

◆ dirichletAtPos()

◆ elementMapper()

◆ episodeEnd()

◆ gravity()

◆ gridView()

◆ init()

◆ initial()

◆ initialAtPos()

◆ maxTimeStepSize()

◆ model() [1/2]

◆ model() [2/2]

◆ name()

◆ neumann()

◆ neumannAtPos()

◆ nextTimeStepSize()

◆ postTimeStep()

◆ pressureModel() [1/2]

◆ pressureModel() [2/2]

◆ preTimeStep()

◆ referencePressure()

◆ referencePressureAtPos()

◆ restart()

◆ resultWriter() [1/2]

◆ resultWriter() [2/2]

◆ serialize()

◆ setName()

◆ setOutputInterval()

◆ setOutputTimeInterval()

◆ setTimeStepSize()

◆ shouldWriteOutput()

◆ shouldWriteRestartFile()

◆ source()

◆ sourceAtPos()

◆ spatialParams() [1/2]

◆ spatialParams() [2/2]

◆ temperature()

◆ temperatureAtPos()

◆ timeIntegration()

◆ timeManager() [1/2]

◆ timeManager() [2/2]

◆ timeStepSize()

◆ variables() [1/2]

◆ variables() [2/2]

◆ vertexMapper()

◆ writeOutput()