writeCellVolumes.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2016-2021 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::functionObjects::writeCellVolumes
26 
27 Description
28  Writes the cell-volumes volScalarField.
29 
30  Example of function object specification:
31  \verbatim
32  writeCellVolumes
33  {
34  type writeCellVolumes;
35  libs ("libfieldFunctionObjects.so");
36  ...
37  }
38  \endverbatim
39 
40 Usage
41  \table
42  Property | Description | Required | Default value
43  type | type name: writeCellVolumes | yes |
44  \endtable
45 
46 See also
47  Foam::functionObjects::fvMeshFunctionObject
48 
49 SourceFiles
50  writeCellVolumes.C
51 
52 \*---------------------------------------------------------------------------*/
53 
54 #ifndef functionObjects_writeCellVolumes_H
55 #define functionObjects_writeCellVolumes_H
56 
57 #include "fvMeshFunctionObject.H"
58 
59 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
60 
61 namespace Foam
62 {
63 namespace functionObjects
64 {
65 
66 /*---------------------------------------------------------------------------*\
67  Class writeCellVolumes Declaration
68 \*---------------------------------------------------------------------------*/
69 
70 class writeCellVolumes
71 :
72  public fvMeshFunctionObject
73 {
74 public:
75 
76  //- Runtime type information
77  TypeName("writeCellVolumes");
78 
79 
80  // Constructors
81 
82  //- Construct from Time and dictionary
84  (
85  const word& name,
86  const Time& runTime,
87  const dictionary& dict
88  );
89 
90  //- Disallow default bitwise copy construction
91  writeCellVolumes(const writeCellVolumes&) = delete;
92 
93 
94  //- Destructor
95  virtual ~writeCellVolumes();
96 
97 
98  // Member Functions
99 
100  //- Return the list of fields required
101  virtual wordList fields() const
102  {
103  return wordList::null();
104  }
105 
106  //- Do nothing
107  virtual bool execute();
108 
109  //- Write the cell-centre fields
110  virtual bool write();
111 
112 
113  // Member Operators
114 
115  //- Disallow default bitwise assignment
116  void operator=(const writeCellVolumes&) = delete;
117 };
118 
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 } // End namespace functionObjects
123 } // End namespace Foam
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
127 #endif
128 
129 // ************************************************************************* //
dictionary dict
const word & name() const
Return the name of this functionObject.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
Writes the cell-volumes volScalarField.
void operator=(const writeCellVolumes &)=delete
Disallow default bitwise assignment.
virtual wordList fields() const
Return the list of fields required.
virtual bool write()
Write the cell-centre fields.
static const List< T > & null()
Return a null List.
Definition: ListI.H:118
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:69
A class for handling words, derived from string.
Definition: word.H:59
TypeName("writeCellVolumes")
Runtime type information.
virtual bool execute()
Do nothing.
writeCellVolumes(const word &name, const Time &runTime, const dictionary &dict)
Construct from Time and dictionary.
Namespace for OpenFOAM.