FreeFOAM The Cross-Platform CFD Toolkit
components.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) 1991-2010 OpenCFD Ltd.
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::components
26 
27 Description
28  Writes scalar fields corresponding to each component of the supplied
29  field (name) for each time.
30 
31 SourceFiles
32  components.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef components_H
37 #define components_H
38 
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 namespace calcTypes
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class components Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
55  public calcType
56 {
57  // Private Member Functions
58 
59  //- Disallow default bitwise copy construct
60  components(const components&);
61 
62  //- Disallow default bitwise assignment
63  void operator=(const components&);
64 
65 
66 protected:
67 
68  // Member Functions
69 
70  // Calculation routines
71 
72  //- Initialise - typically setting static variables,
73  // e.g. command line arguments
74  virtual void init();
75 
76  //- Pre-time loop calculations
77  virtual void preCalc
78  (
79  const argList& args,
80  const Time& runTime,
81  const fvMesh& mesh
82  );
83 
84  //- Time loop calculations
85  virtual void calc
86  (
87  const argList& args,
88  const Time& runTime,
89  const fvMesh& mesh
90  );
91 
92 
93  // I-O
94 
95  //- Write component fields
96  template<class Type>
98  (
99  const IOobject& header,
100  const fvMesh& mesh,
101  bool& processed
102  );
103 
104 
105 public:
106 
107  //- Runtime type information
108  TypeName("components");
109 
110 
111  // Constructors
112 
113  //- Construct null
114  components();
115 
116 
117  // Destructor
118 
119  virtual ~components();
120 };
121 
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 } // End namespace calcTypes
126 } // End namespace Foam
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 #ifdef NoRepository
132 #endif
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 #endif
137 
138 // ************************ vim: set sw=4 sts=4 et: ************************ //