coordinateSystems.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) 2011-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::coordinateSystems::coordinateSystems
26 
27 Description
28  Provides a centralised coordinateSystem collection.
29 
30  For example with the porous region specified in \c constant/fvModels as
31 
32  \verbatim
33  porosity
34  {
35  type explicitPorositySource;
36 
37  explicitPorositySourceCoeffs
38  {
39  selectionMode cellZone;
40  cellZone porousBlockage;
41 
42  type DarcyForchheimer;
43 
44  // D 100; // Very little blockage
45  // D 200; // Some blockage but steady flow
46  // D 500; // Slight waviness in the far wake
47  D 1000; // Fully shedding behavior
48 
49  d ($D $D $D);
50  f (0 0 0);
51 
52  coordinateSystem porousBlockage;
53  }
54  }
55  \endverbatim
56 
57  the corresponding coordinate system \c porousBlockage is looked-up
58  automatically from the \c constant/coordinateSystems dictionary:
59 
60  \verbatim
61  porousBlockage
62  {
63  type cartesian;
64  origin (0 0 0);
65  coordinateRotation
66  {
67  type axesRotation;
68  e1 (1 0 0);
69  e2 (0 1 0);
70  }
71  }
72  \endverbatim
73 
74  See \c tutorials/incompressible/pisoFoam/laminar/porousBlockage
75 
76 SourceFiles
77  coordinateSystems.C
78 
79 \*---------------------------------------------------------------------------*/
80 #ifndef coordinateSystems_H
81 #define coordinateSystems_H
82 
83 #include "coordinateSystem.H"
84 #include "PtrDictionary.H"
85 #include "MeshObject.H"
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 namespace Foam
90 {
91 namespace coordinateSystems
92 {
93 
94 /*---------------------------------------------------------------------------*\
95  Class coordinateSystems Declaration
96 \*---------------------------------------------------------------------------*/
97 
99 :
100  public MeshObject<objectRegistry, GeometricMeshObject, coordinateSystems>,
101  public PtrDictionary<coordinateSystem>
102 {
103 public:
104 
105  //- Runtime type information
106  TypeName("coordinateSystems");
107 
108 
109  // Constructors
110 
111  //- Read construct from objectRegistry
112  explicit coordinateSystems(const objectRegistry& obr);
113 
114  //- Disallow default bitwise copy construction
115  coordinateSystems(const coordinateSystems&) = delete;
116 
117  using MeshObject
118  <
122  >::New;
123 
124 
125  //- Destructor
126  virtual ~coordinateSystems()
127  {}
128 
129 
130  // Member Functions
131 
132  //- ReadData function required for regIOobject read operation
133  virtual bool readData(Istream&);
134 
135 
136  // Member Operators
137 
138  //- Disallow default bitwise assignment
139  void operator=(const coordinateSystems&) = delete;
140 };
141 
142 
143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144 
145 } // End namespace Foam
146 } // End namespace coordinateSystems
147 
148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
149 
150 #endif
151 
152 // ************************************************************************* //
Template dictionary class which manages the storage associated with it.
Definition: PtrDictionary.H:53
Provides a centralised coordinateSystem collection.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
GeometricMeshObject(const word &typeName, const objectRegistry &obr)
Definition: MeshObject.H:231
void operator=(const coordinateSystems &)=delete
Disallow default bitwise assignment.
virtual bool readData(Istream &)
ReadData function required for regIOobject read operation.
Templated abstract base-class for optional mesh objects used to automate their allocation to the mesh...
Definition: MeshObject.H:85
TypeName("coordinateSystems")
Runtime type information.
static coordinateSystems & New(objectRegistry &mesh)
Definition: MeshObject.C:54
coordinateSystems(const objectRegistry &obr)
Read construct from objectRegistry.
Registry of regIOobjects.
Namespace for OpenFOAM.