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