nonUniformField.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) 2012-2015 OpenFOAM Foundation
9  Copyright (C) 2019-2020 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 Class
28  Foam::nonUniformField
29 
30 Description
31 
32 SourceFiles
33  nonUniformField.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef nonUniformField_H
38 #define nonUniformField_H
39 
40 #include "triSurfaceFields.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 class triSurfaceMesh;
51 class searchableSurface;
52 
53 /*---------------------------------------------------------------------------*\
54  Class nonUniformField Declaration
55 \*---------------------------------------------------------------------------*/
56 
57 class nonUniformField
58 :
60 {
61 
62 protected:
63 
64  // Typedefs
65 
67  <
70 
71 
72  // Private data
73 
75 
77 
79 
80 
81 public:
82 
83  //- Runtime type information
84  TypeName("nonUniformField");
85 
86 
87  // Constructors
88 
89  //- Construct from components
91  (
92  const dictionary& cellSizeFunctionDict,
93  const searchableSurface& surface,
94  const scalar& defaultCellSize
95  );
96 
97 
98  //- Destructor
99  virtual ~nonUniformField() = default;
100 
101 
102  // Member Functions
103 
104  // Query
105 
106  //- Return the interpolated cell size for a point in the given
107  // surface triangle
108  virtual scalar interpolate
109  (
110  const point& pt,
111  const label index
112  ) const;
113 };
114 
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 } // End namespace Foam
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 #endif
123 
124 // ************************************************************************* //
PrimitivePatchInterpolation.H
Foam::nonUniformField::~nonUniformField
virtual ~nonUniformField()=default
Destructor.
triSurfaceFields.H
Fields for triSurface.
Foam::triSurfaceMesh
IOoject and searching on triSurface.
Definition: triSurfaceMesh.H:106
Foam::nonUniformField::surfaceTriMesh_
const triSurfaceMesh & surfaceTriMesh_
Definition: nonUniformField.H:73
Foam::nonUniformField::nonUniformField
nonUniformField(const dictionary &cellSizeFunctionDict, const searchableSurface &surface, const scalar &defaultCellSize)
Construct from components.
Foam::nonUniformField::cellSizeCalculationType_
autoPtr< cellSizeCalculationType > cellSizeCalculationType_
Definition: nonUniformField.H:75
Foam::Field< vector >
Foam::searchableSurface
Base class of (analytical or triangulated) surface. Encapsulates all the search routines....
Definition: searchableSurface.H:69
surfaceCellSizeFunction.H
Foam::nonUniformField::pointCellSize_
triSurfacePointScalarField pointCellSize_
Definition: nonUniformField.H:77
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
cellSizeCalculationType.H
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::PrimitivePatchInterpolation
Interpolation class within a primitive patch. Allows interpolation from points to faces and vice vers...
Definition: PrimitivePatchInterpolation.H:53
Foam::Vector< scalar >
Foam::nonUniformField
Definition: nonUniformField.H:56
Foam::nonUniformField::TypeName
TypeName("nonUniformField")
Runtime type information.
Foam::nonUniformField::primitivePatchInterpolation
PrimitivePatchInterpolation< PrimitivePatch<::Foam::List< labelledTri >, pointField > > primitivePatchInterpolation
Definition: nonUniformField.H:68
Foam::surfaceCellSizeFunction
Abstract base class for specifying target cell sizes.
Definition: surfaceCellSizeFunction.H:53
Foam::nonUniformField::interpolate
virtual scalar interpolate(const point &pt, const label index) const
Return the interpolated cell size for a point in the given.
Foam::DimensionedField< scalar, triSurfacePointGeoMesh >
Foam::PrimitivePatch
A list of faces which address into the list of points.
Definition: PrimitivePatch.H:85