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  Copyright (C) 2011-2013 by Andreas Lauser
5 
6  This file is part of the Open Porous Media project (OPM).
7 
8  OPM is free software: you can redistribute it and/or modify
9  it under the terms of the GNU General Public License as published by
10  the Free Software Foundation, either version 2 of the License, or
11  (at your option) any later version.
12 
13  OPM is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  GNU General Public License for more details.
17 
18  You should have received a copy of the GNU General Public License
19  along with OPM. If not, see <http://www.gnu.org/licenses/>.
20 */
26 #ifndef EWOMS_NULL_CONVERGENCE_WRITER_HH
27 #define EWOMS_NULL_CONVERGENCE_WRITER_HH
28 
30 
31 namespace Ewoms {
32 namespace Properties {
33 NEW_PROP_TAG(NewtonMethod);
34 
35 NEW_PROP_TAG(SolutionVector);
36 NEW_PROP_TAG(GlobalEqVector);
37 }
38 }
39 
40 namespace Ewoms {
46 template <class TypeTag>
48 {
49  typedef typename GET_PROP_TYPE(TypeTag, NewtonMethod) NewtonMethod;
50 
51  typedef typename GET_PROP_TYPE(TypeTag, SolutionVector) SolutionVector;
52  typedef typename GET_PROP_TYPE(TypeTag, GlobalEqVector) GlobalEqVector;
53 
54 public:
55  NullConvergenceWriter(NewtonMethod &method)
56  {}
57 
63  {}
64 
70  {}
71 
81  void writeFields(const SolutionVector &uLastIter,
82  const GlobalEqVector &deltaU)
83  {}
84 
89  void endIteration()
90  {}
91 
99  void endTimeStep()
100  {}
101 };
102 
103 } // namespace Ewoms
104 
105 #endif
A convergence writer for the Newton method which does nothing.
Definition: nullconvergencewriter.hh:47
NullConvergenceWriter(NewtonMethod &method)
Definition: nullconvergencewriter.hh:55
The multi-dimensional Newton method.
Definition: newtonmethod.hh:54
NEW_PROP_TAG(Grid)
The type of the DUNE grid.
Definition: baseauxiliarymodule.hh:35
void writeFields(const SolutionVector &uLastIter, const GlobalEqVector &deltaU)
Write the Newton update to disk.
Definition: nullconvergencewriter.hh:81
void beginTimeStep()
Called by the Newton method before the actual algorithm is started for any given timestep.
Definition: nullconvergencewriter.hh:62
Provides the magic behind the eWoms property system.
void endIteration()
Called by the Newton method after an iteration of the Newton algorithm has been completed.
Definition: nullconvergencewriter.hh:89
void beginIteration()
Called by the Newton method before an iteration of the Newton algorithm is started.
Definition: nullconvergencewriter.hh:69
void endTimeStep()
Called by the Newton method after Newton algorithm has been completed for any given timestep...
Definition: nullconvergencewriter.hh:99