IOporosityModelList.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-2014 OpenFOAM Foundation
9 Copyright (C) 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 "IOporosityModelList.H"
30#include "fvMesh.H"
31#include "Time.H"
32
33// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
34
35Foam::IOobject Foam::IOporosityModelList::createIOobject
36(
37 const fvMesh& mesh
38) const
39{
41 (
42 "porosityProperties",
43 mesh.time().constant(),
44 mesh,
47 );
48
49 if (io.typeHeaderOk<IOdictionary>(true))
50 {
51 Info<< "Creating porosity model list from " << io.name() << nl << endl;
52
54 }
55 else
56 {
57 Info<< "No porosity models present" << nl << endl;
58
60 }
61
62 return io;
63}
64
65
66// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
67
69(
70 const fvMesh& mesh
71)
72:
73 IOdictionary(createIOobject(mesh)),
75{}
76
77
79{
81 {
83 return true;
84 }
85
86 return false;
87}
88
89
90// ************************************************************************* //
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 of porosity models with IO functionality.
virtual bool read()
Read dictionary.
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
List container for porosity models.
virtual bool read()
Read object.
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