3.2-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Member Functions | List of all members
Dumux::DiffusionProblem1P< TypeTag > Class Template Reference

Base class for all single phase diffusion problems. More...

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

Inheritance diagram for Dumux::DiffusionProblem1P< TypeTag >:
Inheritance graph

Description

template<class TypeTag>
class Dumux::DiffusionProblem1P< TypeTag >

Base class for all single phase diffusion problems.

Template Parameters
TypeTagThe Type Tag

Public Member Functions

 DiffusionProblem1P (TimeManager &timeManager, Grid &grid)
 Constructs a DiffusionProblem1P object. More...
 
 DiffusionProblem1P (TimeManager &timeManager, Grid &grid, SpatialParams &spatialParams)
 Constructs a DiffusionProblem1P object. More...
 
 DiffusionProblem1P (Grid &grid)
 The constructor. More...
 
 DiffusionProblem1P (Grid &grid, SpatialParams &spatialParams)
 The constructor. 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 timeIntegration ()
 Called by TimeManager in order to do a time integration on the model. 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

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

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...
 
VtkMultiWriterresultWriter ()
 
VtkMultiWriterresultWriter () const
 

Constructor & Destructor Documentation

◆ DiffusionProblem1P() [1/4]

template<class TypeTag >
Dumux::DiffusionProblem1P< TypeTag >::DiffusionProblem1P ( TimeManager &  timeManager,
Grid &  grid 
)
inline

Constructs a DiffusionProblem1P object.

Parameters
timeManagerthe time manager
gridThe grid

◆ DiffusionProblem1P() [2/4]

template<class TypeTag >
Dumux::DiffusionProblem1P< TypeTag >::DiffusionProblem1P ( TimeManager &  timeManager,
Grid &  grid,
SpatialParams &  spatialParams 
)
inline

Constructs a DiffusionProblem1P object.

Parameters
timeManagerthe time manager
gridThe grid
spatialParamsSpatialParams instantiation

◆ DiffusionProblem1P() [3/4]

template<class TypeTag >
Dumux::DiffusionProblem1P< TypeTag >::DiffusionProblem1P ( Grid &  grid)
inline

The constructor.

Parameters
gridThe grid

◆ DiffusionProblem1P() [4/4]

template<class TypeTag >
Dumux::DiffusionProblem1P< TypeTag >::DiffusionProblem1P ( Grid &  grid,
SpatialParams &  spatialParams 
)
inline

The constructor.

Parameters
gridThe grid
spatialParamsSpatialParams 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
bcTypesThe boundary types for the conservation equations
intersectionThe 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
bcTypesThe boundary types for the conservation equations
globalPosThe 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
valuesThe dirichlet values for the primary variables
intersectionThe 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
valuesThe dirichlet values for the primary variables
globalPosThe 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::DiffusionProblem1P< 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
valuesThe initial values for the primary variables
elementThe 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
valuesThe dirichlet values for the primary variables
globalPosThe 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
valuesThe neumann values for the conservation equations [kg / (m^2 *s )]
intersectionThe 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
valuesThe neumann values for the conservation equations [kg / (m^2 *s )]
globalPosThe 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.

◆ preTimeStep()

template<class TypeTag >
void Dumux::OneModelProblem< TypeTag >::preTimeStep ( )
inlineinherited

Called by TimeManager just before the time integration.

◆ referencePressure()

template<class TypeTag >
Scalar Dumux::DiffusionProblem1P< TypeTag >::referencePressure ( const Element &  element) const
inline

Returns the reference pressure for evaluation of constitutive relations.

Parameters
elementThe element

◆ referencePressureAtPos()

template<class TypeTag >
Scalar Dumux::DiffusionProblem1P< TypeTag >::referencePressureAtPos ( const GlobalPosition &  globalPos) const
inline

Returns the reference pressure for evaluation of constitutive relations.

Parameters
globalPosThe 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
valuesThe source and sink values for the conservation equations
elementThe 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
valuesThe source and sink values for the conservation equations
globalPosThe 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::DiffusionProblem1P< TypeTag >::spatialParams ( )
inline

Returns the spatial parameters object.

◆ spatialParams() [2/2]

template<class TypeTag >
const SpatialParams & Dumux::DiffusionProblem1P< TypeTag >::spatialParams ( ) const
inline

Returns the spatial parameters object.

◆ temperature()

template<class TypeTag >
Scalar Dumux::DiffusionProblem1P< TypeTag >::temperature ( const Element &  element) const
inline

Returns the temperature within the domain.

Parameters
elementThe element

◆ temperatureAtPos()

template<class TypeTag >
Scalar Dumux::DiffusionProblem1P< TypeTag >::temperatureAtPos ( const GlobalPosition &  globalPos) const
inline

Returns the temperature within the domain.

Parameters
globalPosThe position of the center of an element

◆ timeIntegration()

template<class TypeTag >
void Dumux::OneModelProblem< TypeTag >::timeIntegration ( )
inlineinherited

Called by TimeManager in order to do a time integration on the model.

◆ 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: