Loading...
Searching...
No Matches
fvbasenewtonconvergencewriter.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_NEWTON_CONVERGENCE_WRITER_HH
#define EWOMS_FV_BASE_NEWTON_CONVERGENCE_WRITER_HH
#include <opm/models/io/vtkmultiwriter.hh>
#include <opm/models/utils/basicproperties.hh>
#include <opm/models/utils/propertysystem.hh>
#include <iostream>
#include <memory>
namespace Opm::Properties {
// forward declaration of the required property tags
template<class TypeTag, class MyTypeTag>
struct SolutionVector;
template<class TypeTag, class MyTypeTag>
struct GlobalEqVector;
template<class TypeTag, class MyTypeTag>
struct NewtonMethod;
template<class TypeTag, class MyTypeTag>
struct VtkOutputFormat;
} // namespace Opm::Properties
namespace Opm {
template <class TypeTag>
class FvBaseNewtonConvergenceWriter
{
using GridView = GetPropType<TypeTag, Properties::GridView>;
using SolutionVector = GetPropType<TypeTag, Properties::SolutionVector>;
using GlobalEqVector = GetPropType<TypeTag, Properties::GlobalEqVector>;
using NewtonMethod = GetPropType<TypeTag, Properties::NewtonMethod>;
static constexpr auto vtkFormat = getPropValue<TypeTag, Properties::VtkOutputFormat>();
using VtkMultiWriter = ::Opm::VtkMultiWriter<GridView, vtkFormat>;
public:
explicit FvBaseNewtonConvergenceWriter(NewtonMethod& nm)
: newtonMethod_(nm)
{
timeStepIdx_ = 0;
iteration_ = 0;
}
void beginTimeStep()
{
++timeStepIdx_;
iteration_ = 0;
}
void beginIteration()
{
++iteration_;
if (!vtkMultiWriter_) {
vtkMultiWriter_ =
std::make_unique<VtkMultiWriter>(/*async=*/false,
newtonMethod_.problem().gridView(),
newtonMethod_.problem().outputDir(),
"convergence");
}
vtkMultiWriter_->beginWrite(timeStepIdx_ + iteration_ / 100.0);
}
void writeFields(const SolutionVector& uLastIter,
const GlobalEqVector& deltaU)
{
try {
newtonMethod_.problem().model().addConvergenceVtkFields(*vtkMultiWriter_,
uLastIter,
deltaU);
}
catch (...) {
std::cout << "Oops: exception thrown on rank "
<< newtonMethod_.problem().gridView().comm().rank()
<< " while writing the convergence\n" << std::flush;
}
}
void endIteration()
{ vtkMultiWriter_->endWrite(false); }
void endTimeStep()
{ iteration_ = 0; }
private:
int timeStepIdx_;
int iteration_;
std::unique_ptr<VtkMultiWriter> vtkMultiWriter_{};
NewtonMethod& newtonMethod_;
};
} // namespace Opm
#endif
basicproperties.hh
Defines a type tags and some fundamental properties all models.
Opm::FvBaseNewtonConvergenceWriter::writeFields
void writeFields(const SolutionVector &uLastIter, const GlobalEqVector &deltaU)
Write the Newton update to disk.
Definition fvbasenewtonconvergencewriter.hh:118
Opm::FvBaseNewtonConvergenceWriter::beginTimeStep
void beginTimeStep()
Called by the Newton method before the actual algorithm is started for any given timestep.
Definition fvbasenewtonconvergencewriter.hh:86
Opm::FvBaseNewtonConvergenceWriter::endTimeStep
void endTimeStep()
Called by the Newton method after Newton algorithm has been completed for any given timestep.
Definition fvbasenewtonconvergencewriter.hh:147
Opm::FvBaseNewtonConvergenceWriter::beginIteration
void beginIteration()
Called by the Newton method before an iteration of the Newton algorithm is started.
Definition fvbasenewtonconvergencewriter.hh:96
Opm::FvBaseNewtonConvergenceWriter::endIteration
void endIteration()
Called by the Newton method after an iteration of the Newton algorithm has been completed.
Definition fvbasenewtonconvergencewriter.hh:137
Opm::VtkMultiWriter
Simplifies writing multi-file VTK datasets.
Definition vtkmultiwriter.hh:65
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
Opm::getPropValue
constexpr auto getPropValue()
get the value data member of a property
Definition propertysystem.hh:240
propertysystem.hh
The Opm property system, traits with inheritance.
Opm::Properties::GlobalEqVector
Vector containing a quantity of for equation for each DOF of the whole grid.
Definition linalgproperties.hh:54
Opm::Properties::NewtonMethod
Specifies the type of the actual Newton method.
Definition newtonmethodproperties.hh:32
Opm::Properties::SolutionVector
Vector containing all primary variables of the grid.
Definition fvbaseproperties.hh:126
Opm::Properties::VtkOutputFormat
Specify the format the VTK output is written to disk.
Definition fvbaseproperties.hh:195
vtkmultiwriter.hh
Simplifies writing multi-file VTK datasets.