processorField.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-2018 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::processorField
26 
27 Description
28  Writes a scalar field whose value is the local processor ID. The output
29  field name is 'processorID'.
30 
31  Example of function object specification:
32  \verbatim
33  processorField1
34  {
35  type processorField;
36  libs ("libfieldFunctionObjects.so");
37  ...
38  }
39  \endverbatim
40 
41 Usage
42  \table
43  Property | Description | Required | Default value
44  type | type name: processorField | yes |
45  \endtable
46 
47 See also
48  Foam::functionObjects::fvMeshFunctionObject
49 
50 SourceFiles
51  processorField.C
52 
53 \*---------------------------------------------------------------------------*/
54 
55 #ifndef functionObjects_processorField_H
56 #define functionObjects_processorField_H
57 
58 #include "fvMeshFunctionObject.H"
59 
60 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
61 
62 namespace Foam
63 {
64 namespace functionObjects
65 {
66 
67 /*---------------------------------------------------------------------------*\
68  Class processorField Declaration
69 \*---------------------------------------------------------------------------*/
70 
71 class processorField
72 :
73  public fvMeshFunctionObject
74 {
75  // Private member functions
76 
77  //- Disallow default bitwise copy construct
78  processorField(const processorField&);
79 
80  //- Disallow default bitwise assignment
81  void operator=(const processorField&);
82 
83 
84 public:
85 
86  //- Runtime type information
87  TypeName("processorField");
88 
89 
90  // Constructors
91 
92  //- Construct from Time and dictionary
94  (
95  const word& name,
96  const Time& runTime,
97  const dictionary& dict
98  );
99 
100 
101  //- Destructor
102  virtual ~processorField();
103 
104 
105  // Member Functions
106 
107  //- Read the input data
108  virtual bool read(const dictionary&);
109 
110  //- Calculate the processorID field
111  virtual bool execute();
112 
113  //- Write the processorID field
114  virtual bool write();
115 };
116 
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 } // End namespace functionObjects
121 } // End namespace Foam
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 #endif
126 
127 // ************************************************************************* //
virtual ~processorField()
Destructor.
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:137
engineTime & runTime
virtual bool execute()
Calculate the processorID field.
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
virtual bool write()
Write the processorID field.
virtual bool read(const dictionary &)
Read the input data.
A class for handling words, derived from string.
Definition: word.H:59
TypeName("processorField")
Runtime type information.
Writes a scalar field whose value is the local processor ID. The output field name is &#39;processorID&#39;...
Namespace for OpenFOAM.