SlicedDimensionedField.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-2022 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::SlicedDimensionedField
26 
27 Description
28  Specialisation of DimensionedField which holds a slice of a given complete
29  field in such a form that it acts as a DimensionedField.
30 
31  The destructor is wrapped to avoid deallocation of the storage of the
32  complete fields when this is destroyed.
33 
34 SourceFiles
35  SlicedDimensionedField.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef SlicedDimensionedField_H
40 #define SlicedDimensionedField_H
41 
42 #include "DimensionedField.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class SlicedDimensionedField Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 template<class Type, class GeoMesh>
55 :
56  public DimensionedField<Type, GeoMesh>
57 {
58 public:
59 
60  // Public Typedefs
61 
62  //- Type of mesh on which this SlicedDimensionedField is instantiated
63  typedef typename GeoMesh::Mesh Mesh;
64 
65 
66  // Constructors
67 
68  //- Construct from components and field to slice
70  (
71  const IOobject&,
72  const Mesh&,
73  const dimensionSet&,
74  const Field<Type>& iField
75  );
76 
77 
78  //- Destructor
80 };
81 
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 } // End namespace Foam
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 #ifdef NoRepository
90  #include "SlicedDimensionedField.C"
91 #endif
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 #endif
96 
97 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
GeoMesh::Mesh Mesh
Type of mesh on which this DimensionedField is instantiated.
Pre-declare SubField and related Field type.
Definition: Field.H:83
MESH Mesh
Definition: GeoMesh.H:61
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:99
Specialisation of DimensionedField which holds a slice of a given complete field in such a form that ...
GeoMesh::Mesh Mesh
Type of mesh on which this SlicedDimensionedField is instantiated.
SlicedDimensionedField(const IOobject &, const Mesh &, const dimensionSet &, const Field< Type > &iField)
Construct from components and field to slice.
Dimension set for the base types.
Definition: dimensionSet.H:125
Namespace for OpenFOAM.