writeCellCentres.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) 2016 OpenFOAM Foundation
9  Copyright (C) 2016-2020 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
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 "writeCellCentres.H"
30 #include "volFields.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37 namespace functionObjects
38 {
39  defineTypeNameAndDebug(writeCellCentres, 0);
40  addToRunTimeSelectionTable(functionObject, writeCellCentres, dictionary);
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 
59 
60 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
61 
63 {
65 }
66 
67 
69 {
70  return true;
71 }
72 
73 
75 {
76  const volVectorField C
77  (
78  IOobject
79  (
80  mesh_.C().name(),
81  time_.timeName(),
82  mesh_,
86  ),
87  mesh_.C(),
89  );
90 
91  Log << type() << " " << name() << " write:" << nl
92  << " writing cell-centres field " << C.name()
93  << " to " << time_.timeName() << endl;
94 
95  C.write();
96 
97  for (direction i = 0; i < vector::nComponents; ++i)
98  {
99  const volScalarField Ci
100  (
101  IOobject
102  (
103  mesh_.C().name() + vector::componentNames[i],
104  time_.timeName(),
105  mesh_,
109  ),
110  mesh_.C().component(i)
111  );
112 
113  Log << " Writing the "
114  << vector::componentNames[i]
115  << " component field of the cell-centres " << Ci.name()
116  << " to " << time_.timeName() << endl;
117 
118  Ci.write();
119  }
120 
121  return true;
122 }
123 
124 
125 // ************************************************************************* //
dictionary dict
Graphite solid properties.
Definition: C.H:46
defineTypeNameAndDebug(ObukhovLength, 0)
uint8_t direction
Definition: direction.H:46
virtual bool write()
Write the cell-centre fields.
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
virtual bool execute()
Do nothing.
constexpr char nl
The newline &#39;\n&#39; character (0x0a)
Definition: Ostream.H:50
engineTime & runTime
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:531
::Foam::direction nComponents(const expressions::valueTypeCode) noexcept
The number of components associated with given valueTypeCode.
Definition: exprTraits.C:40
Ignore writing from objectRegistry::writeObject()
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:69
virtual bool read(const dictionary &)
Read the cell-centre rate data.
Macros for easy insertion into run-time selection tables.
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: POSIX.C:799
writeCellCentres(const word &name, const Time &runTime, const dictionary &dict)
Construct from Time and dictionary.
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for expressions::valueTypeCode::INVALID.
Definition: exprTraits.C:127
A class for handling words, derived from Foam::string.
Definition: word.H:63
virtual bool write(const token &tok)=0
Write token to stream or otherwise handle it.
void read(Istream &, label &val, const dictionary &)
In-place read with dictionary lookup.
volScalarField & C
addToRunTimeSelectionTable(functionObject, ObukhovLength, dictionary)
Nothing to be read.
static const word & calculatedType() noexcept
The type name for calculated patch fields.
Definition: fvPatchField.H:204
#define Log
Definition: PDRblock.C:28
virtual bool read(const dictionary &dict)
Read optional controls.
Defines the attributes of an object for which implicit objectRegistry management is supported...
Definition: IOobject.H:172
Do not request registration (bool: false)
Namespace for OpenFOAM.