opm-simulators
nullconvergencewriter.hh
Go to the documentation of this file.
1 // -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 // vi: set et ts=4 sw=4 sts=4:
3 /*
4  This file is part of the Open Porous Media project (OPM).
5 
6  OPM is free software: you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation, either version 2 of the License, or
9  (at your option) any later version.
10 
11  OPM is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with OPM. If not, see <http://www.gnu.org/licenses/>.
18 
19  Consult the COPYING file in the top-level source directory of this
20  module for the precise wording of the license and the list of
21  copyright holders.
22 */
28 #ifndef EWOMS_NULL_CONVERGENCE_WRITER_HH
29 #define EWOMS_NULL_CONVERGENCE_WRITER_HH
30 
33 
35 
36 namespace Opm::Properties {
37 
38 template <class TypeTag, class MyTypeTag>
39 struct NewtonMethod;
40 
41 } // namespace Opm::Properties
42 
43 namespace Opm {
49 template <class TypeTag>
51 {
53 
56 
57 public:
58  explicit NullConvergenceWriter(NewtonMethod&)
59  {}
60 
66  {}
67 
73  {}
74 
84  void writeFields(const SolutionVector&,
85  const GlobalEqVector&)
86  {}
87 
92  void endIteration()
93  {}
94 
102  void endTimeStep()
103  {}
104 };
105 
106 } // namespace Opm
107 
108 #endif
void beginTimeStep()
Called by the Newton method before the actual algorithm is started for any given timestep.
Definition: nullconvergencewriter.hh:65
A convergence writer for the Newton method which does nothing.
Definition: nullconvergencewriter.hh:50
void beginIteration()
Called by the Newton method before an iteration of the Newton algorithm is started.
Definition: nullconvergencewriter.hh:72
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
void endTimeStep()
Called by the Newton method after Newton algorithm has been completed for any given timestep...
Definition: nullconvergencewriter.hh:102
void endIteration()
Called by the Newton method after an iteration of the Newton algorithm has been completed.
Definition: nullconvergencewriter.hh:92
void writeFields(const SolutionVector &, const GlobalEqVector &)
Write the Newton update to disk.
Definition: nullconvergencewriter.hh:84
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition: blackoilbioeffectsmodules.hh:45
Declare the properties used by the infrastructure code of the finite volume discretizations.
The Opm property system, traits with inheritance.
Definition: blackoilmodel.hh:80
Declares the properties required by the black oil model.