A sampledSurface defined by a distance to a surface. More...
Public Member Functions | |
| TypeName ("distanceSurface") | |
| Runtime type information. More... | |
| distanceSurface (const word &name, const polyMesh &mesh, const dictionary &dict) | |
| Construct from dictionary. More... | |
| virtual | ~distanceSurface () |
| Destructor. More... | |
| virtual bool | needsUpdate () const |
| Does the surface need an update? More... | |
| virtual void | print (Ostream &) const |
| Print. More... | |
 Public Member Functions inherited from sampledIsoSurfaceSurface | |
| TypeName ("sampledIsoSurfaceSurface") | |
| Runtime type information. More... | |
| sampledIsoSurfaceSurface (const word &name, const polyMesh &mesh, const dictionary &dict) | |
| Construct from dictionary. More... | |
| virtual | ~sampledIsoSurfaceSurface () |
| Destructor. More... | |
| virtual bool | expire () |
| Mark the surface as needing an update. More... | |
| virtual bool | update () |
| Update the surface as required. More... | |
| virtual bool | update () const |
| Update the surface as required. More... | |
| virtual const pointField & | points () const |
| Points of surface. More... | |
| virtual const faceList & | faces () const |
| Faces of surface. More... | |
| FOR_ALL_FIELD_TYPES (DEFINE_SAMPLE) | |
| FOR_ALL_FIELD_TYPES (DEFINE_INTERPOLATE) | |
| template<class Type > | |
| Foam::tmp< Foam::Field< Type > > | sampleField (const VolField< Type > &vField) const |
| template<class Type > | |
| Foam::tmp< Foam::Field< Type > > | interpolateField (const interpolation< Type > &interpolator) const |
| Public Member Functions inherited from sampledSurface | |
| TypeName ("sampledSurface") | |
| Runtime type information. More... | |
| declareRunTimeSelectionTable (autoPtr, sampledSurface, word,(const word &name, const polyMesh &mesh, const dictionary &dict),(name, mesh, dict)) | |
| Declare run-time constructor selection table. More... | |
| sampledSurface (const word &name, const polyMesh &, const bool interpolate=false) | |
| Construct from name, mesh. More... | |
| sampledSurface (const word &name, const polyMesh &, const dictionary &) | |
| Construct from dictionary. More... | |
| autoPtr< sampledSurface > | clone () const |
| Clone. More... | |
| virtual | ~sampledSurface () |
| Destructor. More... | |
| const polyMesh & | mesh () const |
| Access to the underlying mesh. More... | |
| const word & | name () const |
| Name of surface. More... | |
| bool | interpolate () const |
| Interpolation requested for surface. More... | |
| virtual wordList | fields () const |
| Return the list of fields required. More... | |
| virtual const vectorField & | Sf () const |
| Return face area vectors. More... | |
| virtual const scalarField & | magSf () const |
| Return face area magnitudes. More... | |
| virtual const vectorField & | Cf () const |
| Return face centres as vectorField. More... | |
| scalar | area () const |
| The total surface area. More... | |
| template<class Type > | |
| Type | integrate (const Field< Type > &) const |
| Integration of a field across the surface. More... | |
| template<class Type > | |
| Type | integrate (const tmp< Field< Type >> &) const |
| Integration of a field across the surface. More... | |
| template<class Type > | |
| Type | average (const Field< Type > &) const |
| Area-averaged value of a field across the surface. More... | |
| template<class Type > | |
| Type | average (const tmp< Field< Type >> &) const |
| Area-averaged value of a field across the surface. More... | |
| tmp< Field< scalar > > | project (const Field< scalar > &) const |
| Project field onto surface. More... | |
| tmp< Field< scalar > > | project (const Field< vector > &) const |
| Project field onto surface. More... | |
| tmp< Field< vector > > | project (const Field< sphericalTensor > &) const |
| Project field onto surface. More... | |
| tmp< Field< vector > > | project (const Field< symmTensor > &) const |
| Project field onto surface. More... | |
| tmp< Field< vector > > | project (const Field< tensor > &) const |
| Project field onto surface. More... | |
| virtual tmp< scalarField > | sample (const volScalarField &) const =0 |
| Sample field on surface. More... | |
| virtual tmp< vectorField > | sample (const volVectorField &) const =0 |
| Sample field on surface. More... | |
| virtual tmp< sphericalTensorField > | sample (const volSphericalTensorField &) const =0 |
| Sample field on surface. More... | |
| virtual tmp< symmTensorField > | sample (const volSymmTensorField &) const =0 |
| Sample field on surface. More... | |
| virtual tmp< tensorField > | sample (const volTensorField &) const =0 |
| Sample field on surface. More... | |
| virtual tmp< scalarField > | sample (const surfaceScalarField &) const |
| Surface sample field on surface. More... | |
| virtual tmp< vectorField > | sample (const surfaceVectorField &) const |
| Surface Sample field on surface. More... | |
| virtual tmp< sphericalTensorField > | sample (const surfaceSphericalTensorField &) const |
| Surface sample field on surface. More... | |
| virtual tmp< symmTensorField > | sample (const surfaceSymmTensorField &) const |
| Surface sample field on surface. More... | |
| virtual tmp< tensorField > | sample (const surfaceTensorField &) const |
| Surface sample field on surface. More... | |
| virtual tmp< scalarField > | interpolate (const interpolation< scalar > &) const =0 |
| Interpolate field on surface. More... | |
| virtual tmp< vectorField > | interpolate (const interpolation< vector > &) const =0 |
| Interpolate field on surface. More... | |
| virtual tmp< sphericalTensorField > | interpolate (const interpolation< sphericalTensor > &) const =0 |
| Interpolate field on surface. More... | |
| virtual tmp< symmTensorField > | interpolate (const interpolation< symmTensor > &) const =0 |
| Interpolate field on surface. More... | |
| virtual tmp< tensorField > | interpolate (const interpolation< tensor > &) const =0 |
| Interpolate field on surface. More... | |
| virtual void | rename (const word &newName) |
| Rename. More... | |
| template<class ReturnType , class Type > | |
| Foam::tmp< Foam::Field< ReturnType > > | project (const tmp< Field< Type >> &field) const |
Additional Inherited Members | |
| Static Public Member Functions inherited from sampledSurface | |
| static autoPtr< sampledSurface > | New (const word &name, const polyMesh &, const dictionary &) |
| Return a reference to the selected surface. More... | |
| Protected Member Functions inherited from sampledIsoSurfaceSurface | |
| const labelList & | zoneIDs () const |
| Access the zone indices. More... | |
| const label & | timeIndex () const |
| Access the time index. More... | |
| Protected Member Functions inherited from sampledSurface | |
| virtual void | clearGeom () const |
A sampledSurface defined by a distance to a surface.
Example:
{
type distanceSurface;
surfaceType searchableBox;
min (-1 -1 -1);
max (1 1 1);
distance 0.1;
signed yes;
interpolate yes;
}
| Property | Description | Required | Default value |
|---|---|---|---|
surfaceType | the type of surface to sample from | yes | |
distance | the distance from which to sample the surface | yes | |
signed | sample only on one side of the surface, specified by the sign of the distance | yes | |
interpolate | interpolate values to the surface points | no | no |
Definition at line 98 of file sampledDistanceSurface.H.
| distanceSurface | ( | const word & | name, |
| const polyMesh & | mesh, | ||
| const dictionary & | dict | ||
| ) |
Construct from dictionary.
Definition at line 100 of file sampledDistanceSurface.C.
|
virtual |
Destructor.
Definition at line 132 of file sampledDistanceSurface.C.
| TypeName | ( | "distanceSurface" | ) |
Runtime type information.
|
virtual |
Does the surface need an update?
Implements sampledSurface.
Definition at line 138 of file sampledDistanceSurface.C.
References timeIndex.
|
virtual |
Print.
Reimplemented from sampledSurface.
Definition at line 144 of file sampledDistanceSurface.C.
References Foam::name(), and points.
1.9.1