basicproperties.hh File Reference

Defines a type tags and some fundamental properties all models. More...

#include <dune/common/parametertree.hh>
#include <ewoms/common/propertysystem.hh>
#include <ewoms/common/parametersystem.hh>
#include <ewoms/io/dgfgridmanager.hh>
#include <ewoms/aux/compatibility.hh>
#include <string>

Go to the source code of this file.

Functions

 Ewoms::Properties::NEW_TYPE_TAG (NumericModel, INHERITS_FROM(ParameterSystem))
 Type tag for all models.
 
 Ewoms::Properties::NEW_TYPE_TAG (ImplicitModel, INHERITS_FROM(NumericModel))
 Type tag for all fully coupled models.
 
 Ewoms::Properties::NEW_PROP_TAG (Scalar)
 Property to specify the type of scalar values. More...
 
 Ewoms::Properties::NEW_PROP_TAG (ParameterTree)
 Property which provides a Dune::ParameterTree.
 
 Ewoms::Properties::NEW_PROP_TAG (ModelParameterGroup)
 Property which defines the group that is queried for parameters by default.
 
 Ewoms::Properties::NEW_PROP_TAG (GridManager)
 Property which provides a GridManager (manages grids)
 
 Ewoms::Properties::NEW_PROP_TAG (GridView)
 The type of the grid view.
 
 Ewoms::Properties::NEW_PROP_TAG (GridGlobalRefinements)
 Property which tells the GridManager how often the grid should be refined after creation. More...
 
 Ewoms::Properties::NEW_PROP_TAG (ParameterFile)
 Property provides the name of the file from which the additional runtime parameters should to be loaded from.
 
 Ewoms::Properties::NEW_PROP_TAG (PrintProperties)
 Print all properties on startup? More...
 
 Ewoms::Properties::NEW_PROP_TAG (PrintParameters)
 Print all parameters on startup? More...
 
 Ewoms::Properties::NEW_PROP_TAG (EndTime)
 The default value for the simulation's end time.
 
 Ewoms::Properties::NEW_PROP_TAG (InitialTimeStepSize)
 The default value for the simulation's initial time step size.
 
 Ewoms::Properties::NEW_PROP_TAG (RestartTime)
 The default value for the simulation's restart time.
 
 Ewoms::Properties::NEW_PROP_TAG (PredeterminedTimeStepsFile)
 The name of the file with a number of forced time step lengths.
 
 Ewoms::Properties::SET_TYPE_PROP (NumericModel, Scalar, double)
 Set the default type of scalar values to double.
 
 Ewoms::Properties::SET_PROP (NumericModel, ParameterTree)
 Set the ParameterTree property.
 
 Ewoms::Properties::SET_STRING_PROP (NumericModel, ModelParameterGroup, "")
 use the global group as default for the model's parameter group
 
 Ewoms::Properties::SET_TYPE_PROP (NumericModel, GridManager, Ewoms::DgfGridManager< TypeTag >)
 Use the DgfGridManager by default.
 
 Ewoms::Properties::SET_STRING_PROP (NumericModel, GridFile, "")
 Set a value for the GridFile property.
 
 Ewoms::Properties::SET_TYPE_PROP (NumericModel, GridView, typename GET_PROP_TYPE(TypeTag, Grid)::LeafGridView)
 Use the leaf grid view by default. More...
 
 Ewoms::Properties::SET_STRING_PROP (NumericModel, ParameterFile, "")
 Set a value for the ParameterFile property.
 
 Ewoms::Properties::SET_INT_PROP (NumericModel, GridGlobalRefinements, 0)
 Set the number of refinement levels of the grid to 0. More...
 
 Ewoms::Properties::SET_INT_PROP (NumericModel, PrintProperties, 2)
 By default, print the properties on startup.
 
 Ewoms::Properties::SET_INT_PROP (NumericModel, PrintParameters, 2)
 By default, print the values of the run-time parameters on startup.
 
 Ewoms::Properties::SET_SCALAR_PROP (NumericModel, EndTime, -1e35)
 The default value for the simulation's end time.
 
 Ewoms::Properties::SET_SCALAR_PROP (NumericModel, InitialTimeStepSize, -1e35)
 The default value for the simulation's initial time step size.
 
 Ewoms::Properties::SET_SCALAR_PROP (NumericModel, RestartTime, -1e35)
 The default value for the simulation's restart time.
 
 Ewoms::Properties::SET_STRING_PROP (NumericModel, PredeterminedTimeStepsFile, "")
 By default, do not force any time steps.
 

Detailed Description

Defines a type tags and some fundamental properties all models.

Function Documentation

◆ NEW_PROP_TAG() [1/4]

Ewoms::Properties::NEW_PROP_TAG ( Scalar  )

Property to specify the type of scalar values.

The type of scalar values.

◆ NEW_PROP_TAG() [2/4]

Ewoms::Properties::NEW_PROP_TAG ( GridGlobalRefinements  )

Property which tells the GridManager how often the grid should be refined after creation.

◆ NEW_PROP_TAG() [3/4]

Ewoms::Properties::NEW_PROP_TAG ( PrintProperties  )

Print all properties on startup?

0 means 'no', 1 means 'yes', 2 means 'print only to logfiles'. The default is 2.

◆ NEW_PROP_TAG() [4/4]

Ewoms::Properties::NEW_PROP_TAG ( PrintParameters  )

Print all parameters on startup?

0 means 'no', 1 means 'yes', 2 means 'print only to logfiles'. The default is 2.

◆ SET_INT_PROP()

Ewoms::Properties::SET_INT_PROP ( NumericModel  ,
GridGlobalRefinements  ,
 
)

Set the number of refinement levels of the grid to 0.

This does not belong here, strictly speaking.

◆ SET_TYPE_PROP()

Ewoms::Properties::SET_TYPE_PROP ( NumericModel  ,
GridView  ,
typename GET_PROP_TYPE(TypeTag, Grid)::LeafGridView   
)

Use the leaf grid view by default.

Except for spatial refinement, there is rarly a reason to use anything else...