Class Sampler

Defined in File Sampler.H

Inheritance Relationships

Derived Types

public MultiCellSampler (Class MultiCellSampler)
public SingleCellSampler (Class SingleCellSampler)

Class Documentation

class Sampler

Class for sampling data to the wall models.

Contributors/Copyright: 2016-2026 Timofey Mukha 2017 Saleh Rezaeiravesh

Source files

Subclassed by MultiCellSampler, SingleCellSampler

Public Functions

Sampler(const fvPatch&, scalar averagingTime, const word interpolationType, const word cellFinderType, const word lengthScaleType, bool hIsIndex, bool excludeWallAdjacent): Construct without typename.

Sampler(const word &samplerName, const fvPatch&, scalar averagingTime, const word interpolationType, const word cellFinderType, const word lengthScaleType, bool hIsIndex, bool excludeWallAdjacent): Construct from typename.

Sampler(const Sampler&): Copy constructor.

virtual ~Sampler(): Destructor.

inline const fvPatch &patch() const: Return the patch.

inline const objectRegistry &db() const: Get the registry with sampled fields.

inline const fvMesh &mesh() const: Get the mesh.

inline scalar averagingTime() const: Get averaging time.

inline label nSampledFields() const: Get the number of sampled fields.

inline word interpolationType() const: Get the interpolation type.

inline word cellFinderType() const: Get the cell finder type.

inline word lengthScaleType() const: Get the length-scale type.

inline bool excludeWallAdjacent() const: Check if wall-adjacent cell is excluded in the multicell sampler.

inline bool hIsIndex() const: Check if h holds the cell index.

inline bool skipSamplingSetup() const: Whether sampling-cell setup is skipped.

void recomputeFields() const: Recompute fields to be sampled.

virtual void sample() const = 0: Sample the fields.

virtual void addField(SampledField*): Add field for sampling.

void write(Ostream &os) const: Write properties to dictionary.

Public Static Functions

static autoPtr<Sampler> New(const word &samplerName, const fvPatch&, scalar averagingTime, const word interpolationType, const word cellFinderType, const word lengthScaleType, bool hIsIndex, bool excludeWallAdjacent)

static autoPtr<Sampler> New(const dictionary&, const fvPatch&)

Protected Functions

virtual void createIndexList() = 0: Create list of cell-indices from where data is sampled.

virtual void createLengthList(const word lengthScaleType) = 0: Compute the length-scales.

virtual void createFields(): Create fields.

Protected Attributes

const fvPatch &patch_: The patch to build the list for.

scalar averagingTime_: Time-averaging scale of the sampled values.

const fvMesh &mesh_: The global object registry.

PtrList<SampledField> sampledFields_: List of sampled fields.

word interpolationType_: Type of interpolation to do within the sampling cell cell, cellPoint or cellPointFace. Defaults to cell.

word cellFinderType_: Type of cellFinder to use for finding sampling cells.

word lengthScaleType_: Way to compute the length-scale for the cells.

bool hIsIndex_: Whether the h field is the consecutive index of the sampling cell.

bool excludeWallAdjacent_: Whether to exclude wall-adjacent cell from the sampling cells.

bool skipSamplingSetup_: Whether sampling-cell setup is skipped, e.g. for mesh utilities.