IOMRFZoneList.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) 2012-2017 OpenFOAM Foundation
9 Copyright (C) 2019-2021 OpenCFD Ltd.
10 Copyright (C) 2020 PCOpt/NTUA
11 Copyright (C) 2020 FOSS GP
12-------------------------------------------------------------------------------
13License
14 This file is part of OpenFOAM.
15
16 OpenFOAM is free software: you can redistribute it and/or modify it
17 under the terms of the GNU General Public License as published by
18 the Free Software Foundation, either version 3 of the License, or
19 (at your option) any later version.
20
21 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
22 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
23 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
24 for more details.
25
26 You should have received a copy of the GNU General Public License
27 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
28
29\*---------------------------------------------------------------------------*/
30
31#include "IOMRFZoneList.H"
32#include "fvMesh.H"
33#include "Time.H"
34
35// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
36
37Foam::IOobject Foam::IOMRFZoneList::createIOobject
38(
39 const fvMesh& mesh,
40 const word& solverName
41) const
42{
44 (
45 "MRFProperties" + solverName,
46 mesh.time().constant(),
47 mesh,
50 );
51
52 if (io.typeHeaderOk<IOdictionary>(true))
53 {
54 Info<< "Creating MRF zone list from " << io.name() << endl;
55
57 }
58 else
59 {
60 Info<< "No MRF models present" << nl << endl;
61
63 }
64
65 return io;
66}
67
68
69// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
70
72(
73 const fvMesh& mesh,
74 const word& solverName
75)
76:
77 IOdictionary(createIOobject(mesh, solverName)),
78 MRFZoneList(mesh, *this)
79{}
80
81
83{
85 {
86 MRFZoneList::read(*this);
87 return true;
88 }
89
90 return false;
91}
92
93
94// ************************************************************************* //
List of MRF zones with IO functionality. MRF zones are specified by a list of dictionary entries,...
Definition: IOMRFZoneList.H:75
virtual bool read()
Read dictionary.
Definition: IOMRFZoneList.C:82
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:57
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:170
const word & name() const noexcept
Return the object name.
Definition: IOobjectI.H:65
readOption readOpt() const noexcept
The read option.
Definition: IOobjectI.H:164
bool typeHeaderOk(const bool checkType=true, const bool search=true, const bool verbose=true)
Read header (uses typeFilePath to find file) and check its info.
IOobject(const IOobject &)=default
Copy construct.
@ MUST_READ_IF_MODIFIED
Definition: IOobject.H:180
List container for MRF zomes.
Definition: MRFZoneList.H:61
virtual bool read()
Re-read model coefficients if they have changed.
const word & constant() const
Return constant name.
Definition: TimePathsI.H:96
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91
const Time & time() const
Return the top-level database.
Definition: fvMesh.H:290
virtual bool read()
Read object.
A class for handling words, derived from Foam::string.
Definition: word.H:68
dynamicFvMesh & mesh
IOobject io("surfaceFilmProperties", mesh.time().constant(), mesh, IOobject::READ_IF_PRESENT, IOobject::NO_WRITE, false)
messageStream Info
Information stream (stdout output on master, null elsewhere)
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:372
constexpr char nl
The newline '\n' character (0x0a)
Definition: Ostream.H:53