Transferred copyright to the OpenFOAM Foundation
[OpenFOAM-2.0.x.git] / src / postProcessing / foamCalcFunctions / calcType / calcType.H
blob4519eb61a107f24773b59af6014487e9191768d0
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
11     OpenFOAM is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by
13     the Free Software Foundation, either version 3 of the License, or
14     (at your option) any later version.
16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
19     for more details.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
24 Namespace
25     Foam::calcTypes
27 Description
28     Namespace for post-processing calculation functions
31 Class
32     Foam::calcType
34 Description
35     Base class for post-processing calculation functions
37 SourceFiles
38     calcType.C
40 \*---------------------------------------------------------------------------*/
42 #ifndef calcType_H
43 #define calcType_H
45 #include "autoPtr.H"
46 #include "runTimeSelectionTables.H"
48 #include "fvCFD.H"
50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
52 namespace Foam
55 /*---------------------------------------------------------------------------*\
56                           Class calcType Declaration
57 \*---------------------------------------------------------------------------*/
59 class calcType
61     // Private Member Functions
63         //- Disallow default bitwise copy construct
64         calcType(const calcType&);
66         //- Disallow default bitwise assignment
67         void operator=(const calcType&);
70 protected:
72     // Protected Member Functions
74         // Calculation routines
76             //- Initialise - typically setting static variables,
77             //  e.g. command line arguments
78             virtual void init();
80             //- Pre-time loop calculations
81             virtual void preCalc
82             (
83                 const argList& args,
84                 const Time& runTime,
85                 const fvMesh& mesh
86             );
88             //- Time loop calculations
89             virtual void calc
90             (
91                 const argList& args,
92                 const Time& runTime,
93                 const fvMesh& mesh
94             );
96             //- Post-time loop calculations
97             virtual void postCalc
98             (
99                 const argList& args,
100                 const Time& runTime,
101                 const fvMesh& mesh
102             );
105 public:
107     //- Runtime type information
108     TypeName("calcType");
111     // Declare runtime constructor selection table
113         declareRunTimeSelectionTable
114         (
115             autoPtr,
116             calcType,
117             dictionary,
118             (),
119             ()
120         );
123     // Constructors
125         //- Construct null
126         calcType();
129     // Selectors
131         static autoPtr<calcType> New(const word& calcTypeName);
134     //- Destructor
135     virtual ~calcType();
138     // Member Functions
140         // Calculation routines - wrapped by exception handling loop
142             //- Initialise - typically setting static variables,
143             //  e.g. command line arguments
144             void tryInit();
146             //- Pre-time loop calculations
147             void tryPreCalc
148             (
149                 const argList& args,
150                 const Time& runTime,
151                 const fvMesh& mesh
152             );
154             //- Time loop calculations
155             void tryCalc
156             (
157                 const argList& args,
158                 const Time& runTime,
159                 const fvMesh& mesh
160             );
162             //- Post-time loop calculations
163             void tryPostCalc
164             (
165                 const argList& args,
166                 const Time& runTime,
167                 const fvMesh& mesh
168             );
172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174 } // End namespace Foam
176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
178 #endif
180 // ************************************************************************* //