dsmcFields.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) 2011-2023 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::dsmcFields
26 
27 Description
28  Calculate intensive fields:
29  - UMean
30  - translationalT
31  - internalT
32  - overallT
33  from averaged extensive fields from a DSMC calculation.
34 
35 See also
36  Foam::functionObjects::fvMeshFunctionObject
37 
38 SourceFiles
39  dsmcFields.C
40 
41 \*---------------------------------------------------------------------------*/
42 
43 #ifndef functionObjects_dsmcFields_H
44 #define functionObjects_dsmcFields_H
45 
46 #include "fvMeshFunctionObject.H"
47 
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 
50 namespace Foam
51 {
52 namespace functionObjects
53 {
54 
55 /*---------------------------------------------------------------------------*\
56  Class dsmcFields Declaration
57 \*---------------------------------------------------------------------------*/
58 
59 class dsmcFields
60 :
62 {
63 public:
64 
65  //- Runtime type information
66  TypeName("dsmcFields");
67 
68 
69  // Constructors
70 
71  //- Construct from Time and dictionary
73  (
74  const word& name,
75  const Time& runTime,
76  const dictionary& dict
77  );
78 
79  //- Disallow default bitwise copy construction
80  dsmcFields(const dsmcFields&) = delete;
81 
82 
83  //- Destructor
84  virtual ~dsmcFields();
85 
86 
87  // Member Functions
88 
89  //- Read the dsmcFields data
90  virtual bool read(const dictionary&);
91 
92  //- Return the list of fields required
93  virtual wordList fields() const;
94 
95  //- Do not evaluate the state at the start of the run
96  virtual bool executeAtStart() const
97  {
98  return false;
99  }
100 
101  //- Do nothing
102  virtual bool execute();
103 
104  //- Calculate and write the DSMC fields
105  virtual bool write();
106 
107 
108  // Member Operators
109 
110  //- Disallow default bitwise assignment
111  void operator=(const dsmcFields&) = delete;
112 };
113 
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 } // End namespace functionObjects
118 } // End namespace Foam
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 #endif
123 
124 // ************************************************************************* //
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:76
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
const word & name() const
Return the name of this functionObject.
Calculate intensive fields:
Definition: dsmcFields.H:61
void operator=(const dsmcFields &)=delete
Disallow default bitwise assignment.
virtual wordList fields() const
Return the list of fields required.
Definition: dsmcFields.C:82
dsmcFields(const word &name, const Time &runTime, const dictionary &dict)
Construct from Time and dictionary.
Definition: dsmcFields.C:56
virtual ~dsmcFields()
Destructor.
Definition: dsmcFields.C:70
virtual bool executeAtStart() const
Do not evaluate the state at the start of the run.
Definition: dsmcFields.H:95
virtual bool execute()
Do nothing.
Definition: dsmcFields.C:97
TypeName("dsmcFields")
Runtime type information.
virtual bool write()
Calculate and write the DSMC fields.
Definition: dsmcFields.C:103
virtual bool read(const dictionary &)
Read the dsmcFields data.
Definition: dsmcFields.C:76
Specialisation of Foam::functionObject for an Foam::fvMesh, providing a reference to the Foam::fvMesh...
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.
dictionary dict