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 
32 
33 #include <opm/common/Unused.hpp>
34 
35 namespace Ewoms {
36 namespace Properties {
37 NEW_PROP_TAG(NewtonMethod);
38 
39 NEW_PROP_TAG(SolutionVector);
40 NEW_PROP_TAG(GlobalEqVector);
41 }
42 }
43 
44 namespace Ewoms {
50 template <class TypeTag>
52 {
53  typedef typename GET_PROP_TYPE(TypeTag, NewtonMethod) NewtonMethod;
54 
55  typedef typename GET_PROP_TYPE(TypeTag, SolutionVector) SolutionVector;
56  typedef typename GET_PROP_TYPE(TypeTag, GlobalEqVector) GlobalEqVector;
57 
58 public:
59  NullConvergenceWriter(NewtonMethod& method OPM_UNUSED)
60  {}
61 
67  {}
68 
74  {}
75 
85  void writeFields(const SolutionVector& uLastIter OPM_UNUSED,
86  const GlobalEqVector& deltaU OPM_UNUSED)
87  {}
88 
93  void endIteration()
94  {}
95 
103  void endTimeStep()
104  {}
105 };
106 
107 } // namespace Ewoms
108 
109 #endif
Definition: baseauxiliarymodule.hh:37
void beginIteration()
Called by the Newton method before an iteration of the Newton algorithm is started.
Definition: nullconvergencewriter.hh:73
void endTimeStep()
Called by the Newton method after Newton algorithm has been completed for any given timestep...
Definition: nullconvergencewriter.hh:103
void beginTimeStep()
Called by the Newton method before the actual algorithm is started for any given timestep.
Definition: nullconvergencewriter.hh:66
void writeFields(const SolutionVector &uLastIter OPM_UNUSED, const GlobalEqVector &deltaU OPM_UNUSED)
Write the Newton update to disk.
Definition: nullconvergencewriter.hh:85
void endIteration()
Called by the Newton method after an iteration of the Newton algorithm has been completed.
Definition: nullconvergencewriter.hh:93
The multi-dimensional Newton method.
Definition: newtonmethod.hh:56
Provides the magic behind the eWoms property system.
#define NEW_PROP_TAG(PTagName)
Define a property tag.
Definition: propertysystem.hh:247
A convergence writer for the Newton method which does nothing.
Definition: nullconvergencewriter.hh:51