All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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-2024 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  A 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 /*---------------------------------------------------------------------------*\
46  Class physicalProperties Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 :
51  public IOdictionary
52 {
53 
54 public:
55 
56  //- Runtime type information
57  TypeName("physicalProperties");
58 
59 
60  // Constructors
61 
62  //- Construct from components
63  physicalProperties(const objectRegistry& obr, const word& group);
64 
65  //- Disallow default bitwise copy construction
66  physicalProperties(const physicalProperties&) = delete;
67 
68 
69  //- Destructor
70  virtual ~physicalProperties()
71  {}
72 
73 
74  // Member Functions
75 
76  //- Find the physicalProperties dictionary and return the IOobject
77  static IOobject findModelDict
78  (
79  const objectRegistry& obr,
80  const word& group,
81  bool registerObject = false
82  );
83 
84  //- Read physicalProperties dictionary
85  virtual bool read();
86 
87 
88  // Member Operators
89 
90  //- Disallow default bitwise assignment
91  void operator=(const physicalProperties&) = delete;
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace Foam
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #endif
102 
103 // ************************************************************************* //
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:57
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:99
bool & registerObject()
Register object created from this IOobject with registry if true.
Definition: IOobject.H:346
word group() const
Return group (extension part of name)
Definition: IOobject.C:324
Registry of regIOobjects.
A base class for physical properties.
void operator=(const physicalProperties &)=delete
Disallow default bitwise assignment.
virtual ~physicalProperties()
Destructor.
TypeName("physicalProperties")
Runtime type information.
physicalProperties(const objectRegistry &obr, const word &group)
Construct from components.
static IOobject findModelDict(const objectRegistry &obr, const word &group, bool registerObject=false)
Find the physicalProperties dictionary and return the IOobject.
virtual bool read()
Read physicalProperties dictionary.
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.