Loading...
Searching...
No Matches
processorField.C
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
27\*---------------------------------------------------------------------------*/
28
29#include "processorField.H"
30#include "volFields.H"
33// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34
35namespace Foam
36{
37namespace functionObjects
38{
41}
42}
43
44
45// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
46
48(
49 const word& name,
50 const Time& runTime,
51 const dictionary& dict
52)
53:
54 fvMeshFunctionObject(name, runTime, dict)
55{
56 read(dict);
57
58 volScalarField* procFieldPtr
59 (
61 (
63 (
64 "processorID",
66 mesh_,
70 ),
71 mesh_,
73 )
74 );
76 mesh_.thisDb().store(procFieldPtr);
77}
78
79
80// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
81
85
86 return true;
87}
88
89
91{
92 volScalarField& procField =
93 mesh_.lookupObjectRef<volScalarField>("processorID");
94
95 procField ==
97
98 return true;
99}
100
101
103{
104 const volScalarField& procField =
105 mesh_.lookupObject<volScalarField>("processorID");
107 procField.write();
108
109 return true;
110}
111
112
114{
115 const_cast<objectRegistry&>(mesh_.thisDb()).erase("processorID");
116
117 volScalarField* procFieldPtr
118 (
120 (
122 (
123 "processorID",
124 mesh_.time().timeName(),
125 mesh_,
129 ),
130 mesh_,
132 )
133 );
134
135 mesh_.thisDb().store(procFieldPtr);
136}
137
138
139// ************************************************************************* //
Macros for easy insertion into run-time selection tables.
#define addToRunTimeSelectionTable(baseType, thisType, argNames)
Add to construction table with typeName as the key.
@ REGISTER
Request registration (bool: true).
@ NO_READ
Nothing to be read.
@ NO_WRITE
Ignore writing from objectRegistry::writeObject().
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition IOobject.H:191
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition Time.H:75
static word timeName(const scalar t, const int precision=precision_)
Return a time name for the given scalar time value formatted with the given precision.
Definition Time.C:714
static int myProcNo(const label communicator=worldComm)
Rank of this process in the communicator (starting from masterNo()). Negative if the process is not a...
Definition UPstream.H:1706
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition dictionary.H:133
Abstract base-class for Time/database function objects.
virtual bool read(const dictionary &dict)
Read and set the function object if its data have changed.
const fvMesh & mesh_
Reference to the fvMesh.
fvMeshFunctionObject(const fvMeshFunctionObject &)=delete
No copy construct.
Writes a scalar field whose value is the local processor ID. The output field name is processorID.
processorField(const word &name, const Time &runTime, const dictionary &dict)
Construct from name, Time and dictionary.
virtual bool read(const dictionary &dict)
Read the function-object dictionary.
virtual void updateMesh(const mapPolyMesh &mpm)
Update for changes of mesh.
virtual bool execute()
Execute the function-object operations.
virtual bool write()
Write the function-object results.
const Time & time() const
Return the top-level database.
Definition fvMesh.H:360
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Registry of regIOobjects.
bool erase(const iterator &iter)
Erase an entry specified by the given iterator.
virtual bool write(const bool writeOnProc=true) const
Write using setting from DB.
A class for handling words, derived from Foam::string.
Definition word.H:66
#define defineTypeNameAndDebug(Type, DebugSwitch)
Define the typeName and debug information.
Definition className.H:142
engineTime & runTime
Function objects are OpenFOAM utilities to ease workflow configurations and enhance workflows.
Namespace for OpenFOAM.
const dimensionSet dimless
Dimensionless.
GeometricField< scalar, fvPatchField, volMesh > volScalarField
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for expressions::valueTypeCode::INVALID.
Definition exprTraits.C:127
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.
dictionary dict