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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2016 OpenFOAM Foundation
9 Copyright (C) 2020-2021 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27Class
28 Foam::functionObjects::dsmcFields
29
30Group
31 grpLagrangianFunctionObjects
32
33Description
34 This function object calculates and outputs the intensive fields:
35 - UMean
36 - translationalT
37 - internalT
38 - overallT
39 from averaged extensive fields from a DSMC calculation.
40
41Usage
42 Example of function object specification to calculate DSMC fields:
43 \verbatim
44 dsmcFields1
45 {
46 type dsmcFields;
47 libs (lagrangianFunctionObjects);
48 ...
49 }
50 \endverbatim
51
52 Where the entries comprise:
53 \table
54 Property | Description | Required | Default value
55 type | Type name: dsmcFields | yes |
56 log | Log to standard output | no | yes
57 \endtable
58
59
60SourceFiles
61 dsmcFields.C
62
63\*---------------------------------------------------------------------------*/
64
65#ifndef functionObjects_dsmcFields_H
66#define functionObjects_dsmcFields_H
67
69
70// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71
72namespace Foam
73{
74namespace functionObjects
75{
76
77/*---------------------------------------------------------------------------*\
78 Class dsmcFields Declaration
79\*---------------------------------------------------------------------------*/
80
81class dsmcFields
82:
83 public fvMeshFunctionObject
84{
85
86 // Private Member Functions
87
88 //- No copy construct
89 dsmcFields(const dsmcFields&) = delete;
90
91 //- No copy assignment
92 void operator=(const dsmcFields&) = delete;
93
94
95public:
96
97 //- Runtime type information
98 TypeName("dsmcFields");
99
100
101 // Constructors
102
103 //- Construct from Time and dictionary
105 (
106 const word& name,
107 const Time& runTime,
108 const dictionary& dict
109 );
110
111
112 //- Destructor
113 virtual ~dsmcFields() = default;
114
115
116 // Member Functions
117
118 //- Read the dsmcFields data
119 virtual bool read(const dictionary&);
120
121 //- Do nothing
122 virtual bool execute();
123
124 //- Calculate and write the DSMC fields
125 virtual bool write();
126};
128
129// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130
131} // End namespace functionObjects
132} // End namespace Foam
133
134// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135
136#endif
137
138// ************************************************************************* //
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:80
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
const word & name() const noexcept
Return the name of this functionObject.
This function object calculates and outputs the intensive fields:
Definition: dsmcFields.H:98
virtual ~dsmcFields()=default
Destructor.
virtual bool execute()
Do nothing.
Definition: dsmcFields.C:112
TypeName("dsmcFields")
Runtime type information.
virtual bool write()
Calculate and write the DSMC fields.
Definition: dsmcFields.C:118
virtual bool read(const dictionary &)
Read the dsmcFields data.
Definition: dsmcFields.C:105
Specialization of Foam::functionObject for an Foam::fvMesh, providing a reference to the Foam::fvMesh...
A class for handling words, derived from Foam::string.
Definition: word.H:68
engineTime & runTime
Namespace for OpenFOAM.
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73