Loading...
Searching...
No Matches
fvbaseproperties.hh
Go to the documentation of this file.
// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*
This file is part of the Open Porous Media project (OPM).
OPM is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
OPM is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with OPM. If not, see <http://www.gnu.org/licenses/>.
Consult the COPYING file in the top-level source directory of this
module for the precise wording of the license and the list of
copyright holders.
*/
#ifndef EWOMS_FV_BASE_PROPERTIES_HH
#define EWOMS_FV_BASE_PROPERTIES_HH
#include <opm/models/utils/basicproperties.hh>
namespace Opm::Properties {
namespace TTag {
struct FvBaseNewtonMethod;
struct FiniteDifferenceLocalLinearizer;
struct ParallelBiCGStabLinearSolver;
}
namespace TTag {
struct FvBaseDiscretization
{ using InheritsFrom = std::tuple<FvBaseNewtonMethod, ImplicitModel>; };
} // namespace TTag
template<class TypeTag, class MyTypeTag>
struct LinearSolverSplice { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct LocalLinearizerSplice { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct Evaluation { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct Stencil { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct DiscreteFunctionSpace { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct DiscreteFunction { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct Problem { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct BaseProblem { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct Discretization { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct DiscLocalResidual { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct LocalResidual { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct LocalLinearizer { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct LinearizeNonLocalElements { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct BaseLinearizer { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct EqVector { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct ElementEqVector { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct RateVector { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct BoundaryRateVector { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct Constraints { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct SolutionVector { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct PrimaryVariables { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct IntensiveQuantities { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct DiscIntensiveQuantities { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct ElementContext { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct BoundaryContext { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct ConstraintsContext { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct ExtensiveQuantities { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct GradientCalculator { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct DiscBaseIntensiveQuantities { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct DiscExtensiveQuantities { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct DiscBaseOutputModule { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct GridCommHandleFactory { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct ThreadManager { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct UseLinearizationLock { using type = UndefinedProperty; };
// high-level simulation control
template<class TypeTag, class MyTypeTag>
struct VtkOutputFormat { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct EnableConstraints { using type = UndefinedProperty; };
// mappers from local to global DOF indices
template<class TypeTag, class MyTypeTag>
struct VertexMapper { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct ElementMapper { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct DofMapper { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct TimeDiscHistorySize { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct ExtensiveStorageTerm { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct UseVolumetricResidual { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct EnableExperiments { using type = UndefinedProperty; };
// Set defaults
template<class TypeTag>
struct Splices<TypeTag, TTag::FvBaseDiscretization>
{
using type = std::tuple<GetSplicePropType<TypeTag, TTag::FvBaseDiscretization, Properties::LinearSolverSplice>,
GetSplicePropType<TypeTag, TTag::FvBaseDiscretization, Properties::LocalLinearizerSplice>>;
};
template<class TypeTag>
struct LinearSolverSplice<TypeTag, TTag::FvBaseDiscretization>
{ using type = TTag::ParallelBiCGStabLinearSolver; };
template<class TypeTag>
struct LocalLinearizerSplice<TypeTag, TTag::FvBaseDiscretization>
{ using type = TTag::FiniteDifferenceLocalLinearizer; };
} // namespace Opm::Properties
#endif
basicproperties.hh
Defines a type tags and some fundamental properties all models.
Opm::FvBaseDiscretization
The base class for the finite volume discretization schemes.
Definition fvbasediscretization.hh:298
Opm::Properties::TTag
The generic type tag for problems using the immiscible multi-phase model.
Definition blackoilmodel.hh:81
Opm::Properties::BaseLinearizer
Linearizes the global non-linear system of equations.
Definition fvbaseproperties.hh:105
Opm::Properties::BaseProblem
The type of the base class for all problems which use this model.
Definition fvbaseproperties.hh:84
Opm::Properties::BoundaryContext
The secondary variables of a boundary segment.
Definition fvbaseproperties.hh:143
Opm::Properties::BoundaryRateVector
Type of object for specifying boundary conditions.
Definition fvbaseproperties.hh:119
Opm::Properties::ConstraintsContext
The secondary variables of a constraint degree of freedom.
Definition fvbaseproperties.hh:146
Opm::Properties::Constraints
The class which represents a constraint degree of freedom.
Definition fvbaseproperties.hh:122
Opm::Properties::DiscBaseIntensiveQuantities
The part of the intensive quantities which is specific to the spatial discretization.
Definition fvbaseproperties.hh:156
Opm::Properties::DiscBaseOutputModule
The part of the VTK ouput modules which is specific to the spatial discretization.
Definition fvbaseproperties.hh:164
Opm::Properties::DiscExtensiveQuantities
The part of the extensive quantities which is specific to the spatial discretization.
Definition fvbaseproperties.hh:160
Opm::Properties::DiscIntensiveQuantities
The discretization specific part of the intensive quantities.
Definition fvbaseproperties.hh:136
Opm::Properties::DiscLocalResidual
The discretization specific part of the local residual.
Definition fvbaseproperties.hh:91
Opm::Properties::DiscreteFunctionSpace
The class describing the discrete function space when dune-fem is used, otherwise it points to the st...
Definition fvbaseproperties.hh:74
Opm::Properties::DiscreteFunction
Definition fvbaseproperties.hh:77
Opm::Properties::Discretization
The type of the spatial discretization used by the model.
Definition fvbaseproperties.hh:88
Opm::Properties::DofMapper
The mapper to find the global index of a degree of freedom.
Definition fvbaseproperties.hh:219
Opm::Properties::ElementContext
The secondary variables of all degrees of freedom in an element's stencil.
Definition fvbaseproperties.hh:140
Opm::Properties::ElementEqVector
A vector of holding a quantity for each equation for each DOF of an element.
Definition fvbaseproperties.hh:112
Opm::Properties::ElementMapper
The mapper to find the global index of an element.
Definition fvbaseproperties.hh:213
Opm::Properties::EnableConstraints
Specify whether the some degrees of fredom can be constraint.
Definition fvbaseproperties.hh:199
Opm::Properties::EnableExperiments
Specify if experimental features should be enabled or not.
Definition fvbaseproperties.hh:241
Opm::Properties::EqVector
A vector of holding a quantity for each equation (usually at a given spatial location).
Definition fvbaseproperties.hh:109
Opm::Properties::Evaluation
Representation of a function evaluation and all necessary derivatives with regard to the intensive qu...
Definition fvbaseproperties.hh:66
Opm::Properties::ExtensiveQuantities
Data required to calculate a flux over a face.
Definition fvbaseproperties.hh:149
Opm::Properties::ExtensiveStorageTerm
Specify whether the storage terms use extensive quantities or not.
Definition fvbaseproperties.hh:233
Opm::Properties::GradientCalculator
Calculates gradients of arbitrary quantities at flux integration points.
Definition fvbaseproperties.hh:152
Opm::Properties::GridCommHandleFactory
The class to create grid communication handles.
Definition fvbaseproperties.hh:168
Opm::Properties::IntensiveQuantities
The secondary variables within a sub-control volume.
Definition fvbaseproperties.hh:133
Opm::Properties::LinearSolverSplice
Definition fvbaseproperties.hh:53
Opm::Properties::LinearizeNonLocalElements
Specify if elements that do not belong to the local process' grid partition should be skipped.
Definition fvbaseproperties.hh:101
Opm::Properties::LocalLinearizerSplice
Definition fvbaseproperties.hh:55
Opm::Properties::LocalLinearizer
The type of the local linearizer.
Definition fvbaseproperties.hh:97
Opm::Properties::LocalResidual
The type of the local residual function.
Definition fvbaseproperties.hh:94
Opm::Properties::PrimaryVariables
A vector of primary variables within a sub-control volume.
Definition fvbaseproperties.hh:130
Opm::Properties::Problem
The type of the problem.
Definition fvbaseproperties.hh:81
Opm::Properties::RateVector
Vector containing volumetric or areal rates of quantities.
Definition fvbaseproperties.hh:116
Opm::Properties::SolutionVector
Vector containing all primary variables of the grid.
Definition fvbaseproperties.hh:126
Opm::Properties::Splices
Definition propertysystem.hh:42
Opm::Properties::Stencil
The class describing the stencil of the spatial discretization.
Definition fvbaseproperties.hh:70
Opm::Properties::TTag::FiniteDifferenceLocalLinearizer
Definition fvbasefdlocallinearizer.hh:65
Opm::Properties::TTag::FvBaseDiscretization
The type tag for models based on the finite volume schemes.
Definition fvbaseproperties.hh:47
Opm::Properties::TTag::FvBaseNewtonMethod
Definition fvbasenewtonmethod.hh:50
Opm::Properties::TTag::ParallelBiCGStabLinearSolver
Definition parallelbicgstabbackend.hh:52
Opm::Properties::ThreadManager
The OpenMP threads manager.
Definition fvbaseproperties.hh:174
Opm::Properties::TimeDiscHistorySize
The history size required by the time discretization.
Definition fvbaseproperties.hh:225
Opm::Properties::UndefinedProperty
a tag to mark properties as undefined
Definition propertysystem.hh:38
Opm::Properties::UseLinearizationLock
use locking to prevent race conditions when linearizing the global system of equations in multi-threa...
Definition fvbaseproperties.hh:181
Opm::Properties::UseVolumetricResidual
Specify whether to use volumetric residuals or not.
Definition fvbaseproperties.hh:237
Opm::Properties::VertexMapper
The mapper to find the global index of a vertex.
Definition fvbaseproperties.hh:207
Opm::Properties::VtkOutputFormat
Specify the format the VTK output is written to disk.
Definition fvbaseproperties.hh:195