Set of locations to sample.at patches. More...
Public Member Functions | |
| TypeName ("patchProbes") | |
| Runtime type information. More... | |
| patchProbes (const word &name, const Time &time, const dictionary &dict) | |
| Construct from Time and dictionary. More... | |
| patchProbes (const patchProbes &)=delete | |
| Disallow default bitwise copy construction. More... | |
| virtual | ~patchProbes () |
| Destructor. More... | |
| virtual bool | write () |
| Sample and write. More... | |
| virtual bool | read (const dictionary &) |
| Read. More... | |
| virtual void | findElements (const fvMesh &) |
| Find elements containing patchProbes. More... | |
| void | operator= (const patchProbes &)=delete |
| Disallow default bitwise assignment. More... | |
| template<class Type > | |
| Foam::tmp< Foam::Field< Type > > | sample (const VolField< Type > &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 SurfaceField< Type > &sField) const |
 Public Member Functions inherited from probes | |
| TypeName ("probes") | |
| Runtime type information. More... | |
| probes (const word &name, const Time &time, const dictionary &dict) | |
| Construct from Time and dictionary. More... | |
| probes (const probes &)=delete | |
| Disallow default bitwise copy construction. More... | |
| virtual | ~probes () |
| Destructor. More... | |
| virtual wordList | fields () const |
| Return the list of fields required. More... | |
| virtual const pointField & | probeLocations () const |
| Return locations to probe. More... | |
| virtual const point & | probe (const label i) const |
| Return location for probe i. More... | |
| const labelList & | elements () const |
| Cells to be probed (obtained from the locations) More... | |
| virtual bool | execute () |
| Execute, currently does nothing. More... | |
| virtual void | movePoints (const polyMesh &) |
| Update topology using the given map. More... | |
| virtual void | topoChange (const polyTopoChangeMap &) |
| Update topology using the given map. More... | |
| virtual void | mapMesh (const polyMeshMap &) |
| Update from another mesh using the given map. More... | |
| virtual void | readUpdate (const polyMesh::readUpdateState state) |
| Update topology using the given map due to readUpdate. More... | |
| template<class Type > | |
| tmp< Field< Type > > | sample (const VolField< Type > &) 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 SurfaceField< Type > &) const |
| Sample a surface field at all locations. More... | |
| void | operator= (const probes &)=delete |
| Disallow default bitwise assignment. More... | |
| template<class Type > | |
| Foam::tmp< Foam::Field< Type > > | sample (const VolField< Type > &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 SurfaceField< Type > &sField) const |
| template<class Type > | |
| Foam::tmp< Foam::Field< Type > > | sampleSurfaceFields (const word &fieldName) const |
| Public Member Functions inherited from functionObject | |
| ClassName ("functionObject") | |
| virtual const word & | type () const =0 |
| Runtime type information. More... | |
| declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict)) | |
| functionObject (const word &name, const Time &runTime) | |
| Construct from components. More... | |
| autoPtr< functionObject > | clone () const |
| Return clone. More... | |
| functionObject (const functionObject &)=delete | |
| Disallow default bitwise copy construction. More... | |
| virtual | ~functionObject () |
| Destructor. More... | |
| const word & | name () const |
| Return the name of this functionObject. More... | |
| virtual bool | executeAtStart () const |
| Return true if the functionObject should be executed at the start. More... | |
| virtual bool | end () |
| Called when Time::run() determines that the time-loop exits. More... | |
| virtual scalar | timeToNextAction () |
| Called by Time::adjustTimeStep(). Allows the functionObject to. More... | |
| virtual void | distribute (const polyDistributionMap &) |
| Redistribute or update using the given distribution map. More... | |
| void | operator= (const functionObject &)=delete |
| Disallow default bitwise assignment. More... | |
| 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 label, const zero) | |
| Construct given size and initialised to zero. More... | |
| Field (const UList< vector > &) | |
| Copy constructor of a UList<Type> More... | |
| Field (List< vector > &&) | |
| Mover constructor transferring the List contents. More... | |
| Field (const UIndirectList< vector > &) | |
| Copy constructor of a UIndirectList<Type> More... | |
| Field (const Field< vector > &) | |
| Copy constructor. More... | |
| Field (Field< vector > &, bool reuse) | |
| Copy constructor or re-use as specified. More... | |
| Field (Field< vector > &&) | |
| Move constructor transferring the Field contents. More... | |
| Field (const tmp< Field< vector >> &) | |
| Copy constructor of tmp<Field> 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 (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 | 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 | reset (const Field< vector > &) |
| Reset the field values to the given 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... | |
| VSForm | block (const label start) const |
| tmp< Field< vector > > | T () const |
| Return the field transpose (only defined for second rank tensors) More... | |
| void | operator= (const Field< vector > &) |
| void | operator= (Field< vector > &&) |
| void | operator= (const UList< vector > &) |
| void | operator= (List< vector > &&) |
| void | operator= (const SubField< vector > &) |
| void | operator= (const tmp< Field< vector >> &) |
| void | operator= (const vector &) |
| void | operator= (const zero) |
| void | operator= (const VectorSpace< Form, Cmpt, nCmpt > &) |
| void | operator= (const tmp< Field > &rhs) |
| 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 | |
| int | count () const |
| Return the current reference count. More... | |
| bool | unique () const |
| Return true if the reference count is 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< T > | |
| List () | |
| Null constructor. More... | |
| List (const label) | |
| Construct with given size. More... | |
| List (const label, const T &) | |
| Construct with given size and value for all elements. More... | |
| List (const label, const zero) | |
| Construct with given size initialising all elements to zero. More... | |
| List (const List< T > &) | |
| Copy constructor. More... | |
| template<class T2 > | |
| List (const UList< T2 > &) | |
| Copy constructor from list containing another type. More... | |
| List (List< T > &&) | |
| Move constructor. More... | |
| List (List< T > &, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| List (const UList< T > &, const labelUList &mapAddressing) | |
| Construct as subset. More... | |
| template<class InputIterator > | |
| List (InputIterator first, InputIterator last) | |
| Construct given start and end iterators. More... | |
| template<unsigned Size> | |
| List (const FixedList< T, Size > &) | |
| Construct as copy of FixedList<T, Size> More... | |
| List (const PtrList< T > &) | |
| Construct as copy of PtrList<T> More... | |
| List (const SLList< T > &) | |
| Construct as copy of SLList<T> More... | |
| List (const UIndirectList< T > &) | |
| Construct as copy of UIndirectList<T> More... | |
| List (const BiIndirectList< T > &) | |
| Construct as copy of BiIndirectList<T> More... | |
| List (std::initializer_list< T >) | |
| Construct from an initialiser list. More... | |
| List (Istream &) | |
| Construct from Istream. More... | |
| autoPtr< List< T > > | clone () const |
| Clone. More... | |
| ~List () | |
| Destructor. More... | |
| label | size () const |
| Return the number of elements in the UList. More... | |
| void | resize (const label) |
| Alias for setSize(const label) More... | |
| void | resize (const label, const T &) |
| Alias for setSize(const label, const T&) More... | |
| void | setSize (const label) |
| Reset size of List. More... | |
| void | setSize (const label, const T &) |
| 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 T &) |
| Append an element at the end of the list. More... | |
| void | append (const UList< T > &) |
| Append a List at the end of this list. More... | |
| void | append (const UIndirectList< T > &) |
| Append a UIndirectList at the end of this list. More... | |
| void | transfer (List< T > &) |
| Transfer the contents of the argument List into this list. More... | |
| template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv> | |
| void | transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &) |
| Transfer the contents of the argument List into this list. More... | |
| void | transfer (SortableList< T > &) |
| Transfer the contents of the argument List into this list. More... | |
| T & | newElmt (const label) |
| Return subscript-checked element of UList. More... | |
| void | shallowCopy (const UList< T > &)=delete |
| Disallow implicit shallowCopy. More... | |
| void | operator= (const UList< T > &) |
| Assignment to UList operator. Takes linear time. More... | |
| void | operator= (const List< T > &) |
| Assignment operator. Takes linear time. More... | |
| void | operator= (List< T > &&) |
| Move assignment operator. More... | |
| void | operator= (const SLList< T > &) |
| Assignment to SLList operator. Takes linear time. More... | |
| void | operator= (const UIndirectList< T > &) |
| Assignment to UIndirectList operator. Takes linear time. More... | |
| void | operator= (const BiIndirectList< T > &) |
| Assignment to BiIndirectList operator. Takes linear time. More... | |
| void | operator= (std::initializer_list< T >) |
| Assignment to an initialiser list. More... | |
| void | operator= (const T &) |
| Assignment of all entries to the given value. More... | |
| void | operator= (const zero) |
| Assignment of all entries to zero. More... | |
| Public Member Functions inherited from UList< T > | |
| UList () | |
| Null constructor. More... | |
| UList (T *__restrict__ v, label size) | |
| Construct from components. More... | |
| UList (const UList< T > &)=default | |
| Copy construct. 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 T * | cdata () const |
| Return a const pointer to the first data element,. More... | |
| T * | data () |
| Return a pointer to the first data element,. More... | |
| T & | first () |
| Return the first element of the list. More... | |
| const T & | first () const |
| Return first element of the list. More... | |
| T & | last () |
| Return the last element of the list. More... | |
| const T & | last () 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 | shallowCopy (const UList< T > &) |
| Copy the pointer held by the given UList. More... | |
| void | deepCopy (const UList< T > &) |
| Copy elements of the given UList. More... | |
| T & | operator[] (const label) |
| Return element of UList. More... | |
| const T & | operator[] (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... | |
| void | operator= (const zero) |
| Assignment of all entries to zero. 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... | |
| 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< vector > | subField |
| Declare type of subField. More... | |
| Public Types inherited from List< T > | |
| typedef SubList< T > | subList |
| Declare type of subList. More... | |
| Public Types inherited from UList< T > | |
| typedef T | value_type |
| Type of values the UList contains. More... | |
| typedef T & | reference |
| Type that can be used for storing into. More... | |
| typedef const T & | const_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 T * | iterator |
| Random access iterator for traversing UList. More... | |
| typedef const T * | const_iterator |
| Random access iterator for traversing UList. More... | |
| typedef std::reverse_iterator< iterator > | reverse_iterator |
| Reverse iterator for reverse traversal of UList. More... | |
| typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
| Reverse iterator for reverse traversal of constant UList. More... | |
| Static Public Member Functions inherited from functionObject | |
| static autoPtr< functionObject > | New (const word &name, const Time &, const dictionary &) |
| Select from dictionary, based on its "type" entry. 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< T > | |
| static const List< T > & | null () |
| Return a null List. More... | |
| Static Public Member Functions inherited from UList< T > | |
| static const UList< T > & | null () |
| Return a null UList. More... | |
| Public Attributes inherited from functionObject | |
| Switch | log |
| Switch write log to Info. More... | |
| Switch | executeAtStart_ |
| Switch write log to Info. More... | |
| Static Public Attributes inherited from functionObject | |
| static bool | postProcess |
| Global post-processing mode switch. 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 refCount | |
| refCount () | |
| Construct null initialising count to 0. More... | |
| Protected Member Functions inherited from List< T > | |
| void | size (const label) |
| Override size to be inconsistent with allocated storage. More... | |
| Protected Attributes inherited from probes | |
| const fvMesh & | mesh_ |
| Const reference to fvMesh. More... | |
| wordList | fields_ |
| Names of fields to probe. More... | |
| bool | fixedLocations_ |
| Fixed locations, default = yes. More... | |
| word | interpolationScheme_ |
| Interpolation scheme name. More... | |
| fieldGroup< scalar > | scalarFields_ |
| Categorised scalar/vector/tensor vol fields. More... | |
| fieldGroup< vector > | vectorFields_ |
| fieldGroup< sphericalTensor > | sphericalTensorFields_ |
| fieldGroup< symmTensor > | symmTensorFields_ |
| fieldGroup< tensor > | tensorFields_ |
| fieldGroup< scalar > | surfaceScalarFields_ |
| Categorised scalar/vector/tensor surf fields. More... | |
| fieldGroup< vector > | surfaceVectorFields_ |
| fieldGroup< sphericalTensor > | surfaceSphericalTensorFields_ |
| fieldGroup< symmTensor > | surfaceSymmTensorFields_ |
| fieldGroup< tensor > | surfaceTensorFields_ |
| labelList | elementList_ |
| labelList | faceList_ |
| HashPtrTable< OFstream > | probeFilePtrs_ |
| Current open files. More... | |
| Protected Attributes inherited from functionObject | |
| const Time & | time_ |
| Reference to time. More... | |
Set of locations to sample.at patches.
Call write() to sample and write files.
Definition at line 56 of file patchProbes.H.
| patchProbes | ( | const word & | name, |
| const Time & | time, | ||
| const dictionary & | dict | ||
| ) |
Construct from Time and dictionary.
Definition at line 176 of file patchProbes.C.
References List< T >::clear(), dict, probes::elementList_, probes::faceList_, and patchProbes::read().
|
delete |
Disallow default bitwise copy construction.
|
virtual |
Destructor.
Definition at line 198 of file patchProbes.C.
| TypeName | ( | "patchProbes" | ) |
Runtime type information.
|
virtual |
|
virtual |
Read.
Reimplemented from probes.
Definition at line 223 of file patchProbes.C.
References dict, dictionary::lookup(), and probes::read().
Referenced by patchProbes::patchProbes().
|
virtual |
Find elements containing patchProbes.
Reimplemented from probes.
Definition at line 51 of file patchProbes.C.
References indexedOctree< Type >::bb(), polyMesh::boundaryMesh(), UList< T >::data(), Foam::e, probes::elementList_, Foam::endl(), Foam::exit(), treeBoundBox::extend(), primitiveMesh::faceCentres(), Foam::FatalError, FatalErrorInFunction, polyBoundaryMesh::findPatchID(), forAll, PointIndexHit< Point >::hit(), PointIndexHit< Point >::index(), Foam::Info, InfoInFunction, Pstream::listCombineGather(), Pstream::listCombineScatter(), boundBox::mag(), Foam::magSqr(), UPstream::myProcNo(), UList< T >::operator[](), patchi, PrimitivePatch< FaceList, PointField >::points(), probes::probeLocations(), List< T >::setSize(), indexedOctree< Type >::shapes(), List< T >::size(), Foam::sqr(), polyPatch::start(), polyMesh::tetBasePtIs(), WarningInFunction, and polyBoundaryMesh::whichPatch().
|
delete |
Disallow default bitwise assignment.
| Foam::tmp<Foam::Field<Type> > sample | ( | const VolField< Type > & | vField | ) | const |
Definition at line 149 of file patchProbesTemplates.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), forAll, Pstream::listCombineGather(), Pstream::listCombineScatter(), patches, patchi, and tmp< T >::ref().
| Foam::tmp<Foam::Field<Type> > sample | ( | const word & | fieldName | ) | const |
Definition at line 186 of file patchProbesTemplates.C.
| Foam::tmp<Foam::Field<Type> > sample | ( | const SurfaceField< Type > & | sField | ) | const |
Definition at line 200 of file patchProbesTemplates.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), forAll, Pstream::listCombineGather(), Pstream::listCombineScatter(), patches, patchi, and tmp< T >::ref().
1.9.1 
