physicalProperties.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2021 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::physicalProperties
26 
27 Description
28  An abstract base class for physical properties.
29 
30 SourceFiles
31  physicalProperties.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef physicalProperties_H
36 #define physicalProperties_H
37 
38 #include "IOdictionary.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 // Forward declaration of classes
46 class fvMesh;
47 
48 /*---------------------------------------------------------------------------*\
49  Class physicalProperties Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public IOdictionary
55 {
56 
57 public:
58 
59  //- Runtime type information
60  TypeName("physicalProperties");
61 
62 
63  // Constructors
64 
65  //- Construct from components
66  physicalProperties(const fvMesh& mesh, const word& group);
67 
68  //- Disallow default bitwise copy construction
69  physicalProperties(const physicalProperties&) = delete;
70 
71 
72  //- Destructor
73  virtual ~physicalProperties()
74  {}
75 
76 
77  // Member Functions
78 
79  static IOobject findModelDict
80  (
81  const objectRegistry& obr,
82  const word& group,
83  bool registerObject = false
84  );
85 
86  //- Read physicalProperties dictionary
87  virtual bool read() = 0;
88 
89 
90  // Member Operators
91 
92  //- Disallow default bitwise assignment
93  void operator=(const physicalProperties&) = delete;
94 };
95 
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace Foam
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #endif
104 
105 // ************************************************************************* //
TypeName("physicalProperties")
Runtime type information.
An abstract base class for physical properties.
static IOobject findModelDict(const objectRegistry &obr, const word &group, bool registerObject=false)
void operator=(const physicalProperties &)=delete
Disallow default bitwise assignment.
word group() const
Return group (extension part of name)
Definition: IOobject.C:324
virtual bool read()=0
Read physicalProperties dictionary.
fvMesh & mesh
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:53
A class for handling words, derived from string.
Definition: word.H:59
physicalProperties(const fvMesh &mesh, const word &group)
Construct from components.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:95
virtual ~physicalProperties()
Destructor.
Registry of regIOobjects.
bool & registerObject()
Register object created from this IOobject with registry if true.
Definition: IOobject.H:351
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:98
Namespace for OpenFOAM.