Class SampledField

Inheritance Relationships

Derived Types

Class Documentation

class SampledField

Base class for a sampled field. Handles sampling of and recomputing a specific field. Also registers the field to the object registry under the sub-registry wallModelSampling — patch-name.

Contributors/Copyright: 2018-2021 Timofey Mukha

Source files

Subclassed by SampledPGradField, SampledVelocityField, SampledWallGradUField

Public Functions

inline SampledField(const fvPatch &patch, const word interpolationType = "cell")

Construct from patch and interpolation type.

inline SampledField(const SampledField &orig)

Copy constructor.

virtual autoPtr<SampledField> clone() const = 0

Clone the object.

inline virtual ~SampledField()

Destructor.

inline const fvMesh &mesh() const

Get the mesh.

inline const objectRegistry &db() const

Subregistry for sampled fields.

inline const fvPatch &patch() const

Get the patch.

virtual word name() const = 0

Get the name of the sampled field.

virtual label nDims() const = 0

The number of dimensions of the field.

virtual void sample(scalarListList &sampledValues, const labelList &indexList, const scalarField &h) const = 0

Sample the field.

virtual void sample(scalarListListList &sampledValues, const labelListList &indexListList) const = 0

Sample the field from multiple cells.

virtual void registerFields(const labelList&) const = 0

Register appropriate fields in the object registry.

virtual void registerFields(const labelListList&) const = 0
virtual void recompute() const = 0

Recompute the values of the field.

virtual void createField() const = 0

Create the global field that will be sampled.

inline word interpolationType() const

Get interpolation type.

Protected Attributes

const fvPatch &patch_

The patch.

const fvMesh &mesh_

The mesh.

const word interpolationType_

Interpolation type.