File size: 3,617 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::sampledSurfaces::cutPlane
Description
A sampledSurface defined by a plane.
Example:
\verbatim
{
type cutPlane;
point (0 0 0);
normal (0 0 1);
interpolate yes;
}
\endverbatim
Usage
\table
Property | Description | Required | Default value
planeType | Method of specification. E.g., pointAndNormal. | no
point | A point in the plane (for pointAndNormal) | yes
normal | A vector normal to the plane (for pointAndNormal) | yes
interpolate | Interpolate values to the surface points? | no | no
cellZone | Zone containing cells to include | no | all
\endtable
Note: there are also other options for planeType, including
'planeEquation' and 'embeddedPoints'.
See also
Foam::plane
Foam::generatedCellZone
SourceFiles
sampledCutPlane.C
\*---------------------------------------------------------------------------*/
#ifndef sampledCutPlane_H
#define sampledCutPlane_H
#include "sampledIsoSurfaceSurface.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace sampledSurfaces
{
/*---------------------------------------------------------------------------*\
Class cutPlane Declaration
\*---------------------------------------------------------------------------*/
class cutPlane
:
public sampledIsoSurfaceSurface
{
// Private Data
//- Plane
const plane plane_;
// Private Member Functions
//- Generate the iso surface
virtual autoPtr<cutPolyIsoSurface> calcIsoSurf() const;
public:
//- Runtime type information
TypeName("cutPlane");
// Constructors
//- Construct from dictionary
cutPlane
(
const word& name,
const polyMesh& mesh,
const dictionary& dict
);
//- Destructor
virtual ~cutPlane();
// Member Functions
//- Does the surface need an update?
virtual bool needsUpdate() const;
//- Write
virtual void print(Ostream&) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace sampledSurfaces
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|