Loading...
Searching...
No Matches
cubegridvanguard.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_CUBE_GRID_VANGUARD_HH
#define EWOMS_CUBE_GRID_VANGUARD_HH
#include <dune/common/fvector.hh>
#include <dune/grid/utility/structuredgridfactory.hh>
#include <opm/models/io/basevanguard.hh>
#include <opm/models/utils/basicparameters.hh>
#include <opm/models/utils/basicproperties.hh>
#include <opm/models/utils/propertysystem.hh>
#include <opm/models/utils/parametersystem.hpp>
#include <array>
#include <memory>
namespace Opm {
template <class TypeTag>
class CubeGridVanguard : public BaseVanguard<TypeTag>
{
using ParentType = BaseVanguard<TypeTag>;
using Scalar = GetPropType<TypeTag, Properties::Scalar>;
using Simulator = GetPropType<TypeTag, Properties::Simulator>;
using Grid = GetPropType<TypeTag, Properties::Grid>;
using GridPointer = std::unique_ptr<Grid>;
using CoordScalar = typename Grid::ctype;
enum {
dim = Grid::dimension,
dimWorld = Grid::dimensionworld,
};
using GlobalPosition = Dune::FieldVector<CoordScalar, dimWorld>;
public:
static void registerParameters()
{
Parameters::Register<Parameters::GridGlobalRefinements>
("The number of global refinements of the grid "
"executed after it was loaded");
Parameters::Register<Parameters::DomainSizeX<Scalar>>
("The size of the domain in x direction");
Parameters::Register<Parameters::CellsX>
("The number of intervalls in x direction");
if constexpr (dim > 1) {
Parameters::Register<Parameters::DomainSizeY<Scalar>>
("The size of the domain in y direction");
Parameters::Register<Parameters::CellsY>
("The number of intervalls in y direction");
}
if constexpr (dim > 2) {
Parameters::Register<Parameters::DomainSizeZ<Scalar>>
("The size of the domain in z direction");
Parameters::Register<Parameters::CellsZ>
("The number of intervalls in z direction");
}
}
explicit CubeGridVanguard(Simulator& simulator)
: ParentType(simulator)
{
std::array<unsigned int, dim> cellRes{};
GlobalPosition upperRight(0.0);
GlobalPosition lowerLeft(0.0);
upperRight[0] = Parameters::Get<Parameters::DomainSizeX<Scalar>>();
cellRes[0] = Parameters::Get<Parameters::CellsX>();
if constexpr (dim > 1) {
upperRight[1] = Parameters::Get<Parameters::DomainSizeY<Scalar>>();
cellRes[1] = Parameters::Get<Parameters::CellsY>();
}
if constexpr (dim > 2) {
upperRight[2] = Parameters::Get<Parameters::DomainSizeZ<Scalar>>();
cellRes[2] = Parameters::Get<Parameters::CellsZ>();
}
const unsigned numRefinements = Parameters::Get<Parameters::GridGlobalRefinements>();
cubeGrid_ = Dune::StructuredGridFactory<Grid>::createCubeGrid(lowerLeft, upperRight, cellRes);
cubeGrid_->globalRefine(static_cast<int>(numRefinements));
this->finalizeInit_();
}
Grid& grid()
{ return *cubeGrid_; }
const Grid& grid() const
{ return *cubeGrid_; }
protected:
GridPointer cubeGrid_;
};
} // namespace Opm
#endif
basevanguard.hh
Provides the base class for most (all?) simulator vanguards.
basicparameters.hh
Defines some fundamental parameters for all models.
basicproperties.hh
Defines a type tags and some fundamental properties all models.
Opm::CubeGridVanguard::grid
const Grid & grid() const
Returns a reference to the grid.
Definition cubegridvanguard.hh:133
Opm::CubeGridVanguard::grid
Grid & grid()
Returns a reference to the grid.
Definition cubegridvanguard.hh:127
Opm::CubeGridVanguard::CubeGridVanguard
CubeGridVanguard(Simulator &simulator)
Create the grid.
Definition cubegridvanguard.hh:98
Opm::CubeGridVanguard::registerParameters
static void registerParameters()
Register all run-time parameters for the simulator vanguad.
Definition cubegridvanguard.hh:71
Opm
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition blackoilbioeffectsmodules.hh:43
Opm::GetPropType
typename Properties::Detail::GetPropImpl< TypeTag, Property >::type::type GetPropType
get the type alias defined in the property (equivalent to old macro GET_PROP_TYPE(....
Definition propertysystem.hh:233
parametersystem.hpp
This file provides the infrastructure to retrieve run-time parameters.
Opm::Parameters::Register
void Register(const char *usageString)
Register a run-time parameter.
Definition parametersystem.hpp:292
Opm::Parameters::Get
auto Get(bool errorIfNotRegistered=true)
Retrieve a runtime parameter.
Definition parametersystem.hpp:187
propertysystem.hh
The Opm property system, traits with inheritance.