edgeFieldsFwd.H
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) 2016-2017 Wikki Ltd
9  Copyright (C) 2026 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
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 InNamespace
28  Foam
29 
30 Description
31  Forwards for edge field types
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef Foam_edgeFieldsFwd_H
36 #define Foam_edgeFieldsFwd_H
37 
38 #include "fieldTypes.H"
39 #include "GeometricFieldFwd.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 // Forward Declarations
49 class edgeMesh;
50 template<class Type> class faePatchField;
51 
52 
57 
58 
59 // Typedefs
60 
61 typedef
64 
65 typedef
68 
69 typedef
72 
73 typedef
76 
77 typedef
80 
81 
82 /*---------------------------------------------------------------------------*\
83  Namespace fieldTypes Declaration
84 \*---------------------------------------------------------------------------*/
85 
86 namespace fieldTypes
87 {
88 
89 //- Standard (finite-area) edge field types (scalar, vector, tensor, etc)
90 extern const wordList edge;
91 
92 //- Test if the class name appears to be a (finite-area) edge field
93 bool is_edge(const word& clsName);
94 
95 } // End namespace fieldTypes
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace Foam
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #endif
104 
105 // ************************************************************************* //
bool is_edge(const word &clsName)
Test if the class name appears to be a (finite-area) edge field.
GeometricField< symmTensor, faePatchField, edgeMesh > edgeSymmTensorField
Definition: edgeFieldsFwd.H:69
GeometricField< tensor, faePatchField, edgeMesh > edgeTensorField
Definition: edgeFieldsFwd.H:73
A class for handling words, derived from Foam::string.
Definition: word.H:63
GeometricField< vector, faePatchField, edgeMesh > edgeVectorField
Definition: edgeFieldsFwd.H:61
GeometricField< scalar, faePatchField, edgeMesh > edgeScalarField
Definition: edgeFieldsFwd.H:44
Mesh data needed to do the Finite Area discretisation.
Definition: edgeFaMesh.H:47
const wordList edge
Standard (finite-area) edge field types (scalar, vector, tensor, etc)
GeometricField< sphericalTensor, faePatchField, edgeMesh > edgeSphericalTensorField
Definition: edgeFieldsFwd.H:65
Forward declarations related to GeometricField etc.
faePatchField<Type> abstract base class. This class gives a fat-interface to all derived classes cove...
Definition: edgeFieldsFwd.H:44
Namespace for OpenFOAM.