sampledIsoSurfacePoint.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) 2020-2021 OpenCFD Ltd.
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::sampledIsoSurfacePoint
28
29Description
30 A sampledSurface defined by a surface of iso value using a
31 \em point algorithm (always triangulated!).
32 It only recalculates the iso-surface if time changes.
33 To be used in sampleSurfaces / functionObjects.
34
35Usage
36 Example of function object partial specification:
37 \verbatim
38 surfaces
39 {
40 surface1
41 {
42 type isoSurfacePoint;
43 isoField T;
44 isoValue 373;
45 }
46 }
47 \endverbatim
48
49 Where the sub-entries comprise:
50 \table
51 Property | Description | Required | Default
52 type | isoSurfacePoint | yes |
53 isoField | field name for obtaining iso-surface | yes |
54 isoValue | value of iso-surface | yes |
55 average | cell values from averaged point values | no | false
56 bounds | limit with bounding box | no |
57 zone | limit to cell zone (name or regex) | no |
58 zones | limit to cell zones (names, regexs) | no |
59 regularise | point snapping | yes |
60 mergeTol | tolerance for merging points | no | 1e-6
61 \endtable
62
63Note
64 For the isoMethod \b point should use a "cellPoint" sampleScheme
65 since the triangles generated with this algorithm span across cells.
66
67SourceFiles
68 sampledIsoSurfacePoint.C
69
70\*---------------------------------------------------------------------------*/
71
72#ifndef sampledIsoSurfacePoint_H
73#define sampledIsoSurfacePoint_H
74
75#include "sampledIsoSurface.H"
76
77// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
78
79namespace Foam
80{
81
82/*---------------------------------------------------------------------------*\
83 Class sampledIsoSurfacePoint Declaration
84\*---------------------------------------------------------------------------*/
85
86class sampledIsoSurfacePoint
87:
88 public sampledIsoSurface
89{
90public:
91
92 //- Runtime type information
93 TypeNameNoDebug("sampledIsoSurfacePoint");
94
95
96 // Constructors
97
98 //- Construct from dictionary
100 (
101 const word& name,
102 const polyMesh& mesh,
103 const dictionary& dict
104 );
105
106
107 //- Destructor
108 virtual ~sampledIsoSurfacePoint() = default;
109};
110
111
112// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113
114} // End namespace Foam
115
116// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117
118#endif
119
120// ************************************************************************* //
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:81
A sampledSurface defined by a surface of iso value using a point algorithm (always triangulated!...
TypeNameNoDebug("sampledIsoSurfacePoint")
Runtime type information.
sampledIsoSurfacePoint(const word &name, const polyMesh &mesh, const dictionary &dict)
Construct from dictionary.
virtual ~sampledIsoSurfacePoint()=default
Destructor.
A sampledSurface defined by a surface of iso value. It only recalculates the iso-surface if time chan...
const word & name() const noexcept
Name of surface.
const polyMesh & mesh() const noexcept
Access to the underlying mesh.
A class for handling words, derived from Foam::string.
Definition: word.H:68
Namespace for OpenFOAM.
dictionary dict
#define TypeNameNoDebug(TypeNameString)
Declare a ClassNameNoDebug() with extra virtual type info.
Definition: typeInfo.H:68