Public Member Functions | List of all members
patchProbes Class Reference

Set of locations to sample.at patches. More...

Inheritance diagram for patchProbes:
Inheritance graph
[legend]
Collaboration diagram for patchProbes:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("patchProbes")
 Runtime type information. More...
 
 patchProbes (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~patchProbes ()
 Destructor. More...
 
virtual void write ()
 Public members. More...
 
virtual void read (const dictionary &)
 Read. More...
 
virtual void findElements (const fvMesh &)
 Find elements containing patchProbes. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > sample (const GeometricField< Type, fvPatchField, volMesh > &vField) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > sample (const word &fieldName) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > sample (const GeometricField< Type, fvsPatchField, surfaceMesh > &sField) const
 
- Public Member Functions inherited from probes
 TypeName ("probes")
 Runtime type information. More...
 
 probes (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~probes ()
 Destructor. More...
 
virtual const wordname () const
 Return name of the set of probes. More...
 
virtual const wordReListfieldNames () const
 Return names of fields to probe. More...
 
virtual const pointFieldprobeLocations () const
 Return locations to probe. More...
 
virtual const pointprobe (const label i) const
 Return location for probe i. More...
 
const labelListelements () const
 Cells to be probed (obtained from the locations) More...
 
virtual void execute ()
 Execute, currently does nothing. More...
 
virtual void end ()
 Execute at the final time-loop, currently does nothing. More...
 
virtual void timeSet ()
 Called when time was set at the end of the Time::operator++. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &)
 Update for changes of mesh. More...
 
virtual void readUpdate (const polyMesh::readUpdateState state)
 Update for changes of mesh due to readUpdate. More...
 
template<class Type >
tmp< Field< Type > > sample (const GeometricField< Type, fvPatchField, volMesh > &) const
 Sample a volume field at all locations. More...
 
template<class Type >
tmp< Field< Type > > sample (const word &fieldName) const
 Sample a single vol field on all sample locations. More...
 
template<class Type >
tmp< Field< Type > > sampleSurfaceFields (const word &fieldName) const
 Sample a single scalar field on all sample locations. More...
 
template<class Type >
tmp< Field< Type > > sample (const GeometricField< Type, fvsPatchField, surfaceMesh > &) const
 Sample a surface field at all locations. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > sample (const GeometricField< Type, fvPatchField, volMesh > &vField) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > sample (const word &fieldName) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > sample (const GeometricField< Type, fvsPatchField, surfaceMesh > &sField) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > sampleSurfaceFields (const word &fieldName) const
 
- Public Member Functions inherited from Field< vector >
 Field ()
 Construct null. More...
 
 Field (const label)
 Construct given size. More...
 
 Field (const label, const vector &)
 Construct given size and initial value. More...
 
 Field (const UList< vector > &)
 Construct as copy of a UList<Type> More...
 
 Field (const Xfer< List< vector > > &)
 Construct by transferring the List contents. More...
 
 Field (const UList< vector > &mapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given field. More...
 
 Field (const tmp< Field< vector > > &tmapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given tmp field. More...
 
 Field (const UList< vector > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given field. More...
 
 Field (const tmp< Field< vector > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given tmp field. More...
 
 Field (const UList< vector > &mapF, const FieldMapper &map)
 Construct by mapping from the given field. More...
 
 Field (const UList< vector > &mapF, const FieldMapper &map, const vector &defaultValue)
 Construct by mapping from the given field. More...
 
 Field (const UList< vector > &mapF, const FieldMapper &map, const UList< vector > &defaultValues)
 Construct by mapping from the given field. More...
 
 Field (const tmp< Field< vector > > &tmapF, const FieldMapper &map)
 Construct by mapping from the given tmp field. More...
 
 Field (const tmp< Field< vector > > &tmapF, const FieldMapper &map, const vector &defaultValue)
 Construct by mapping from the given tmp field. Supplied uniform. More...
 
 Field (const tmp< Field< vector > > &tmapF, const FieldMapper &map, const UList< vector > &defaultValues)
 Construct by mapping from the given tmp field. Supplied values. More...
 
 Field (const Field< vector > &)
 Construct as copy. More...
 
 Field (Field< vector > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 Field (const Xfer< Field< vector > > &)
 Construct by transferring the Field contents. More...
 
 Field (const tmp< Field< vector > > &)
 Construct as copy of tmp<Field> More...
 
 Field (Istream &)
 Construct from Istream. More...
 
 Field (const word &keyword, const dictionary &, const label size)
 Construct from a dictionary entry. More...
 
tmp< Field< vector > > clone () const
 Clone. More...
 
void map (const UList< vector > &mapF, const labelUList &mapAddressing)
 1 to 1 map from the given field More...
 
void map (const tmp< Field< vector > > &tmapF, const labelUList &mapAddressing)
 1 to 1 map from the given tmp field More...
 
void map (const UList< vector > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given field. More...
 
void map (const tmp< Field< vector > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given tmp field. More...
 
void map (const UList< vector > &mapF, const FieldMapper &map)
 Map from the given field. More...
 
void map (const tmp< Field< vector > > &tmapF, const FieldMapper &map)
 Map from the given tmp field. More...
 
void autoMap (const FieldMapper &map)
 Map from self. More...
 
void rmap (const UList< vector > &mapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given field More...
 
void rmap (const tmp< Field< vector > > &tmapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given tmp field More...
 
void rmap (const UList< vector > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given field. More...
 
void rmap (const tmp< Field< vector > > &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given tmp field. More...
 
void negate ()
 Negate this field. More...
 
tmp< Field< cmptType > > component (const direction) const
 Return a component field of the field. More...
 
void replace (const direction, const UList< cmptType > &)
 Replace a component field of the field. More...
 
void replace (const direction, const tmp< Field< cmptType > > &)
 Replace a component field of the field. More...
 
void replace (const direction, const cmptType &)
 Replace a component field of the field. More...
 
tmp< Field< vector > > T () const
 Return the field transpose (only defined for second rank tensors) More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write the field as a dictionary entry. More...
 
void operator= (const Field< vector > &)
 
void operator= (const UList< vector > &)
 
void operator= (const SubField< vector > &)
 
void operator= (const tmp< Field< vector > > &)
 
void operator= (const vector &)
 
void operator= (const VectorSpace< Form, Cmpt, nCmpt > &)
 
void operator+= (const UList< vector > &)
 
void operator+= (const tmp< Field< vector > > &)
 
void operator+= (const vector &)
 
void operator-= (const UList< vector > &)
 
void operator-= (const tmp< Field< vector > > &)
 
void operator-= (const vector &)
 
void operator*= (const UList< scalar > &)
 
void operator*= (const tmp< Field< scalar > > &)
 
void operator*= (const scalar &)
 
void operator/= (const UList< scalar > &)
 
void operator/= (const tmp< Field< scalar > > &)
 
void operator/= (const scalar &)
 
- Public Member Functions inherited from refCount
 refCount ()
 Construct null with zero count. More...
 
int count () const
 Return the reference count. More...
 
bool okToDelete () const
 Return true if the reference count is zero. More...
 
void resetRefCount ()
 Reset the reference count to zero. More...
 
void operator++ ()
 Increment the reference count. More...
 
void operator++ (int)
 Increment the reference count. More...
 
void operator-- ()
 Decrement the reference count. More...
 
void operator-- (int)
 Decrement the reference count. More...
 
- Public Member Functions inherited from List< vector >
label size () const
 Return the number of elements in the UList. More...
 
 List ()
 Null constructor. More...
 
 List (const label)
 Construct with given size. More...
 
 List (const label, const vector &)
 Construct with given size and value for all elements. More...
 
 List (const List< vector > &)
 Copy constructor. More...
 
 List (const Xfer< List< vector > > &)
 Construct by transferring the parameter contents. More...
 
 List (List< vector > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< vector > &, const labelUList &mapAddressing)
 Construct as subset. More...
 
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators. More...
 
 List (const FixedList< vector, Size > &)
 Construct as copy of FixedList<T, Size> More...
 
 List (const PtrList< vector > &)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< vector > &)
 Construct as copy of SLList<T> More...
 
 List (const UIndirectList< vector > &)
 Construct as copy of UIndirectList<T> More...
 
 List (const BiIndirectList< vector > &)
 Construct as copy of BiIndirectList<T> More...
 
 List (Istream &)
 Construct from Istream. More...
 
autoPtr< List< vector > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void resize (const label, const vector &)
 Alias for setSize(const label, const T&) More...
 
void setSize (const label)
 Reset size of List. More...
 
void setSize (const label, const vector &)
 Reset size of List and value for new elements. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void append (const vector &)
 Append an element at the end of the list. More...
 
void append (const UList< vector > &)
 Append a List at the end of this list. More...
 
void append (const UIndirectList< vector > &)
 Append a UIndirectList at the end of this list. More...
 
void transfer (List< vector > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (DynamicList< vector, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (SortableList< vector > &)
 Transfer the contents of the argument List into this list. More...
 
Xfer< List< vector > > xfer ()
 Transfer contents to the Xfer container. More...
 
vectornewElmt (const label)
 Return subscript-checked element of UList. More...
 
void operator= (const UList< vector > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const List< vector > &)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< vector > &)
 Assignment from SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< vector > &)
 Assignment from UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< vector > &)
 Assignment from BiIndirectList operator. Takes linear time. More...
 
void operator= (const vector &)
 Assignment of all entries to the given value. More...
 
- Public Member Functions inherited from UList< T >
 UList ()
 Null constructor. More...
 
 UList (T *__restrict__ v, label size)
 Construct from components. More...
 
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index. More...
 
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index. More...
 
std::streamsize byteSize () const
 Return the binary size in number of characters of the UList. More...
 
const Tcdata () const
 Return a const pointer to the first data element,. More...
 
Tdata ()
 Return a pointer to the first data element,. More...
 
Tfirst ()
 Return the first element of the list. More...
 
const Tfirst () const
 Return first element of the list. More...
 
Tlast ()
 Return the last element of the list. More...
 
const Tlast () const
 Return the last element of the list. More...
 
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1). More...
 
void checkSize (const label size) const
 Check size is within valid range (0 ... size). More...
 
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1). More...
 
void writeEntry (Ostream &) const
 Write the UList as a dictionary entry. More...
 
void writeEntry (const word &keyword, Ostream &) const
 Write the UList as a dictionary entry with keyword. More...
 
void assign (const UList< T > &)
 Assign elements to those from UList. More...
 
Toperator[] (const label)
 Return element of UList. More...
 
const Toperator[] (const label) const
 Return element of constant UList. More...
 
 operator const Foam::List< T > & () const
 Allow cast to a const List<T>&. More...
 
void operator= (const T &)
 Assignment of all entries to the given value. More...
 
iterator begin ()
 Return an iterator to begin traversing the UList. More...
 
iterator end ()
 Return an iterator to end traversing the UList. More...
 
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator cend () const
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator end () const
 Return const_iterator to end traversing the constant UList. More...
 
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList. More...
 
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
label size () const
 Return the number of elements in the UList. More...
 
label max_size () const
 Return size of the largest possible UList. More...
 
bool empty () const
 Return true if the UList is empty (ie, size() is zero). More...
 
void swap (UList< T > &)
 Swap two ULists of the same type in constant time. More...
 
bool operator== (const UList< T > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< T > &) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< T > &) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< T > &) const
 Return true if !(a < b). Takes linear time. More...
 
template<>
const bool & operator[] (const label i) const
 

Additional Inherited Members

- Public Types inherited from Field< vector >
typedef pTraits< vector >::cmptType cmptType
 Component type. More...
 
typedef SubField< vectorsubField
 Declare type of subField. More...
 
- Public Types inherited from List< vector >
typedef SubList< vectorsubList
 Declare type of subList. More...
 
- Public Types inherited from UList< T >
typedef T value_type
 Type of values the UList contains. More...
 
typedef Treference
 Type that can be used for storing into. More...
 
typedef const Tconst_reference
 Type that can be used for storing into. More...
 
typedef label difference_type
 The type that can represent the difference between any two. More...
 
typedef label size_type
 The type that can represent the size of a UList. More...
 
typedef Titerator
 Random access iterator for traversing UList. More...
 
typedef const Tconst_iterator
 Random access iterator for traversing UList. More...
 
typedef Treverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef const Tconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList. More...
 
- Static Public Member Functions inherited from Field< vector >
static const Field< vector > & null ()
 Return a null field. More...
 
static tmp< Field< vector > > NewCalculatedType (const Field< Type2 > &f)
 Return a pointer to a new calculatedFvPatchFieldField created on. More...
 
- Static Public Member Functions inherited from List< vector >
static const List< vector > & null ()
 Return a null List. More...
 
- Static Public Member Functions inherited from UList< T >
static const UList< T > & null ()
 Return a null UList. More...
 
- Static Public Attributes inherited from Field< vector >
static const char *const typeName
 
- Protected Member Functions inherited from probes
void clearFieldGroups ()
 Clear old field groups. More...
 
label appendFieldGroup (const word &fieldName, const word &fieldType)
 Append fieldName to the appropriate group. More...
 
label classifyFields ()
 Classify field types, returns the number of fields. More...
 
label prepare ()
 Classify field type and Open/close file streams,. More...
 
- Protected Member Functions inherited from List< vector >
void size (const label)
 Override size to be inconsistent with allocated storage. More...
 
- Protected Attributes inherited from probes
word name_
 Name of this set of probes,. More...
 
const fvMeshmesh_
 Const reference to fvMesh. More...
 
bool loadFromFiles_
 Load fields from files (not from objectRegistry) More...
 
wordReList fieldSelection_
 Names of fields to probe. More...
 
bool fixedLocations_
 Fixed locations, default = yes. More...
 
word interpolationScheme_
 Interpolation scheme name. More...
 
fieldGroup< scalar > scalarFields_
 Categorized scalar/vector/tensor vol fields. More...
 
fieldGroup< vectorvectorFields_
 
fieldGroup< sphericalTensorsphericalTensorFields_
 
fieldGroup< symmTensorsymmTensorFields_
 
fieldGroup< tensortensorFields_
 
fieldGroup< scalar > surfaceScalarFields_
 Categorized scalar/vector/tensor surf fields. More...
 
fieldGroup< vectorsurfaceVectorFields_
 
fieldGroup< sphericalTensorsurfaceSphericalTensorFields_
 
fieldGroup< symmTensorsurfaceSymmTensorFields_
 
fieldGroup< tensorsurfaceTensorFields_
 
labelList elementList_
 
labelList faceList_
 
HashPtrTable< OFstreamprobeFilePtrs_
 Current open files. More...
 

Detailed Description

Set of locations to sample.at patches.

Call write() to sample and write files.

Source files

Definition at line 56 of file patchProbes.H.

Constructor & Destructor Documentation

patchProbes ( const word name,
const objectRegistry obr,
const dictionary dict,
const bool  loadFromFiles = false 
)

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 191 of file patchProbes.C.

References List< T >::clear(), and Foam::read().

Here is the call graph for this function:

~patchProbes ( )
virtual

Destructor.

Definition at line 213 of file patchProbes.C.

Member Function Documentation

TypeName ( "patchProbes"  )

Runtime type information.

void write ( )
virtual

Public members.

Sample and write

Reimplemented from probes.

Definition at line 217 of file patchProbes.C.

void read ( const dictionary dict)
virtual

Read.

Reimplemented from probes.

Definition at line 235 of file patchProbes.C.

References dictionary::lookup(), and probes::read().

Here is the call graph for this function:

void findElements ( const fvMesh mesh)
virtual
Foam::tmp<Foam::Field<Type> > sample ( const GeometricField< Type, fvPatchField, volMesh > &  vField) const
Foam::tmp<Foam::Field<Type> > sample ( const word fieldName) const

Definition at line 230 of file patchProbesTemplates.C.

References objectRegistry::lookupObject(), and probes::mesh_.

Here is the call graph for this function:

Foam::tmp<Foam::Field<Type> > sample ( const GeometricField< Type, fvsPatchField, surfaceMesh > &  sField) const

The documentation for this class was generated from the following files: