faOptions.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) 2019-2021 OpenCFD Ltd.
9 ------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "faOptions.H"
29 #include "faMesh.H"
30 #include "Time.H"
31 
32 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36  namespace fa
37  {
38  defineTypeNameAndDebug(options, 0);
39  }
40 }
41 
42 
43 // * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
44 
45 Foam::IOobject Foam::fa::options::createIOobject
46 (
47  const fvMesh& mesh
48 ) const
49 {
50  IOobject io
51  (
52  typeName,
53  mesh.time().constant(),
54  mesh,
57  );
58 
59  if (io.typeHeaderOk<IOdictionary>(true))
60  {
61  Info<< "Creating finite area options from "
62  << io.instance()/io.name() << nl
63  << endl;
64 
66  }
67  else
68  {
69  // Check if the faOptions file is in system
70  io.instance() = mesh.time().system();
71 
72  if (io.typeHeaderOk<IOdictionary>(true))
73  {
74  Info<< "Creating finite area options from "
75  << io.instance()/io.name() << nl
76  << endl;
77 
79  }
80  else
81  {
82  io.readOpt(IOobject::NO_READ);
83  }
84  }
85 
86  return io;
87 }
88 
89 
90 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
91 
92 Foam::fa::options::options
93 (
94  const fvPatch& p
95 )
96 :
97  IOdictionary(createIOobject(p.boundaryMesh().mesh())),
98  optionList(p, *this)
99 {}
100 
101 
103 {
104  const fvMesh& mesh = p.boundaryMesh().mesh();
105 
106  if (mesh.thisDb().foundObject<options>(typeName))
107  {
108  return const_cast<options&>
109  (
110  mesh.lookupObject<options>(typeName)
111  );
112  }
113  else
114  {
115  if (debug)
116  {
118  << "Constructing " << typeName
119  << " for region " << mesh.name() << endl;
120  }
121 
122  options* objectPtr = new options(p);
123  regIOobject::store(objectPtr);
124  return *objectPtr;
125  }
126 }
127 
128 
130 {
132  {
133  optionList::read(*this);
134  return true;
135  }
136  else
137  {
138  return false;
139  }
140 }
141 
142 
143 // ************************************************************************* //
Foam::expressions::patchExpr::debug
int debug
Static debugging option.
Foam::IOobject::NO_WRITE
Definition: IOobject.H:195
Foam::IOdictionary
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:54
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:169
InfoInFunction
#define InfoInFunction
Report an information message using Foam::Info.
Definition: messageStream.H:350
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::fa::options::New
static options & New(const fvPatch &p)
Definition: faOptions.C:102
Foam::fa::optionList
List of finite volume options.
Definition: faOptionList.H:65
faOptions.H
Foam::IOobject::IOobject
IOobject(const IOobject &)=default
Copy construct.
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:369
faMesh.H
Foam::fa::defineTypeNameAndDebug
defineTypeNameAndDebug(limitVelocity, 0)
Foam::regIOobject::store
bool store()
Definition: regIOobjectI.H:37
Foam::blockMeshTools::read
void read(Istream &, label &val, const dictionary &)
In-place read with dictionary lookup.
Definition: blockMeshTools.C:57
Foam::fa::options::read
virtual bool read()
Read dictionary.
Definition: faOptions.C:129
Foam::Info
messageStream Info
Information stream (stdout output on master, null elsewhere)
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:65
Foam::IOdictionary::IOdictionary
IOdictionary(const IOobject &io, const dictionary *fallback=nullptr)
Definition: IOdictionary.C:37
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:85
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Time.H
Foam::fa::options
Finite-area options.
Definition: faOptions.H:54
Foam::nl
constexpr char nl
Definition: Ostream.H:404
Foam::fa::optionList::read
virtual bool read(const dictionary &dict)
Read dictionary.
Definition: faOptionList.C:156
Foam::IOobject::MUST_READ_IF_MODIFIED
Definition: IOobject.H:186
Foam::IOobject::NO_READ
Definition: IOobject.H:188
Foam::IOobject::MUST_READ
Definition: IOobject.H:185