interpolate.H
Go to the documentation of this file.
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.
10 
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.
15 
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.
20 
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/>.
23 
24 Class
25  Foam::calcTypes::interpolate
26 
27 Description
28  Interpolates volume fields to surface fields for each time.
29 
30 SourceFiles
31  interpolate.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef interpolate_H
36 #define interpolate_H
37 
38 #include "calcType.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 namespace calcTypes
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class interpolate Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class interpolate
53 :
54  public calcType
55 {
56  // Private Member Functions
57 
58  //- Disallow default bitwise copy construct
59  interpolate(const interpolate&);
60 
61  //- Disallow default bitwise assignment
62  void operator=(const interpolate&);
63 
64 
65 protected:
66 
67  // Member Functions
68 
69  // Calculation routines
70 
71  //- Initialise - typically setting static variables,
72  // e.g. command line arguments
73  virtual void init();
74 
75  //- Pre-time loop calculations
76  virtual void preCalc
77  (
78  const argList& args,
79  const Time& runTime,
80  const fvMesh& mesh
81  );
82 
83  //- Time loop calculations
84  virtual void calc
85  (
86  const argList& args,
87  const Time& runTime,
88  const fvMesh& mesh
89  );
90 
91 
92  // I-O
93 
94  //- Write interpolate fields
95  template<class Type>
97  (
98  const IOobject& header,
99  const fvMesh& mesh,
100  bool& processed
101  );
102 
103 
104 public:
105 
106  //- Runtime type information
107  TypeName("interpolate");
108 
109 
110  // Constructors
111 
112  //- Construct null
113  interpolate();
114 
115 
116  //- Destructor
117  virtual ~interpolate();
118 };
119 
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 } // End namespace calcTypes
124 } // End namespace Foam
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 #ifdef NoRepository
129 # include "writeInterpolateField.C"
130 #endif
131 
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 
134 #endif
135 
136 // ************************************************************************* //
Foam::IOobject
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:91
Foam::Time
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
Foam::calcTypes::interpolate::interpolate
interpolate()
Construct null.
Definition: interpolate.C:43
Foam::argList
Extract command arguments and options from the supplied argc and argv parameters.
Definition: argList.H:97
Foam::calcTypes::interpolate
Interpolates volume fields to surface fields for each time.
Definition: interpolate.H:51
Foam::calcTypes::interpolate::calc
virtual void calc(const argList &args, const Time &runTime, const fvMesh &mesh)
Time loop calculations.
Definition: interpolate.C:74
Foam::calcTypes::interpolate::preCalc
virtual void preCalc(const argList &args, const Time &runTime, const fvMesh &mesh)
Pre-time loop calculations.
Definition: interpolate.C:65
Foam::calcTypes::interpolate::init
virtual void init()
Initialise - typically setting static variables,.
Definition: interpolate.C:57
Foam::calcTypes::interpolate::writeInterpolateField
void writeInterpolateField(const IOobject &header, const fvMesh &mesh, bool &processed)
Write interpolate fields.
Definition: writeInterpolateField.C:28
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:18
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::calcTypes::interpolate::operator=
void operator=(const interpolate &)
Disallow default bitwise assignment.
calcType.H
Foam::calcTypes::interpolate::~interpolate
virtual ~interpolate()
Destructor.
Definition: interpolate.C:51
args
Foam::argList args(argc, argv)
Foam::calcType
Base class for post-processing calculation functions.
Definition: calcType.H:58
Foam::calcTypes::interpolate::TypeName
TypeName("interpolate")
Runtime type information.
writeInterpolateField.C