125 public functionObjects::fvMeshFunctionObject,
133 template<
class GeoField>
134 struct fieldGroup :
public DynamicList<word> {};
225 template<
class GeoField>
244 const word& fieldName,
246 const scalar timeValue
250 template<
class GeoField>
258 bool performAction(
unsigned request);
264 void operator=(
const probes&) =
delete;
280 const bool loadFromFiles =
false,
293 bool verbose(
const bool on)
noexcept;
320 virtual bool read(
const dictionary&);
326 virtual bool write();
A 1D vector of objects of type <T> that resizes itself as necessary to accept the new objects.
Minimal example by using system/controlDict.functions:
Generic GeometricField class.
A HashTable of pointers to objects of type <T>, with deallocation management of the pointers.
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
T & operator[](const label i)
Return element of UList.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
const word & name() const noexcept
Return the name of this functionObject.
Specialization of Foam::functionObject for an Foam::fvMesh, providing a reference to the Foam::fvMesh...
Mesh data needed to do the Finite Volume discretisation.
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Mesh consisting of general polyhedral cells.
readUpdateState
Enumeration defining the state of the mesh after a read update.
Set of locations to sample.
word samplePointScheme_
Interpolation/sample scheme to obtain values at the points.
bool verbose(const bool on) noexcept
Enable/disable verbose output.
bool includeOutOfBounds_
Include probes that were not found (default: true)
HashPtrTable< OFstream > probeFilePtrs_
Current open files (non-empty on master only)
fieldGroup< surfaceSphericalTensorField > surfaceSphericalTensorFields_
tmp< Field< Type > > sample(const SurfaceField< Type > &) const
Sample a surface field at all locations.
const labelList & elements() const noexcept
Cells to be probed (obtained from the locations)
void storeResults(const word &fieldName, const Field< Type > &values)
Store results: min/max/average/size.
virtual const wordRes & fieldNames() const noexcept
Return names of fields to probe.
virtual const pointField & probeLocations() const noexcept
Return locations to probe.
labelList processor_
Processor holding the cell or face (-1 if point not found.
fieldGroup< volSphericalTensorField > sphericalTensorFields_
label prepare(unsigned request)
Classify field types, close/open file streams.
pointField oldPoints_
Original probes location (only used for patchProbes)
virtual void findElements(const fvMesh &mesh)
Find cells and faces containing probes.
TypeName("probes")
Runtime type information.
virtual void readUpdate(const polyMesh::readUpdateState state)
Update for changes of mesh due to readUpdate.
fieldGroup< volScalarField > scalarFields_
Categorized scalar/vector/tensor volume fields.
fieldGroup< surfaceSymmTensorField > surfaceSymmTensorFields_
bool loadFromFiles_
Load fields from files (not from objectRegistry)
fieldGroup< volVectorField > vectorFields_
DynamicList< word > selectedFieldNames_
Current list of field names selected for sampling.
fieldGroup< volSymmTensorField > symmTensorFields_
labelList elementList_
Cells to be probed (obtained from the locations)
fieldGroup< surfaceScalarField > surfaceScalarFields_
Categorized scalar/vector/tensor surface fields.
fieldGroup< surfaceTensorField > surfaceTensorFields_
bool verbose_
Output verbosity.
bool fixedLocations_
Fixed locations (default: true)
virtual void movePoints(const polyMesh &)
Update for changes of mesh.
wordRes fieldSelection_
Requested names of fields to probe.
fieldGroup< surfaceVectorField > surfaceVectorFields_
virtual ~probes()=default
Destructor.
tmp< GeoField > getOrLoadField(const word &fieldName) const
Get from registry or load from disk.
labelList patchIDList_
Patch IDs on which the new probes are located (for patchProbes)
tmp< Field< Type > > sample(const word &fieldName) const
Sample a volume field at all locations.
tmp< Field< Type > > sampleSurfaceField(const word &fieldName) const
Sample a surface field at all locations.
labelList faceList_
Faces to be probed.
virtual void updateMesh(const mapPolyMesh &)
Update for changes of mesh.
bool onExecute_
Perform sample actions on execute as well.
virtual const point & probe(const label i) const
Return location for probe i.
virtual bool execute()
Sample and store result if the sampleOnExecute is enabled.
virtual bool write()
Sample and write.
fieldGroup< volTensorField > tensorFields_
tmp< Field< Type > > sample(const VolumeField< Type > &) const
Sample a volume field at all locations.
sampleActionType
Local control for sampling actions.
virtual bool read(const dictionary &)
Read the probes.
A class for managing temporary objects.
A List of wordRe with additional matching capabilities.
A class for handling words, derived from Foam::string.
vectorField pointField
pointField is a vectorField.
void readFields(const typename GeoFieldType::Mesh &mesh, const IOobjectList &objects, const wordHashSet &selectedFields, LIFOStack< regIOobject * > &storedObjects)
Read the selected GeometricFields of the templated type.
Grouping of field names by GeometricField type.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.