Sample probe for temperature using a thermocouple. More...
Public Member Functions | |
TypeName ("thermoCoupleProbes") | |
Runtime type information. More... | |
thermoCoupleProbes (const word &name, const Time &runTime, const dictionary &dict, const bool loadFromFiles=false, const bool readFields=true) | |
Construct for given objectRegistry and dictionary. More... | |
virtual | ~thermoCoupleProbes ()=default |
Destructor. More... | |
virtual label | nEqns () const |
Number of ODE's to solve. More... | |
virtual void | derivatives (const scalar x, const scalarField &y, scalarField &dydx) const |
Calculate the derivatives in dydx. More... | |
virtual void | jacobian (const scalar t, const scalarField &y, scalarField &dfdt, scalarSquareMatrix &dfdy) const |
Calculate the Jacobian of the system. More... | |
virtual bool | read (const dictionary &) |
Read. More... | |
virtual bool | execute () |
Execute. Evaluates the ODESolver. More... | |
virtual bool | write () |
Sample and write. More... | |
Public Member Functions inherited from probes | |
TypeName ("probes") | |
Runtime type information. More... | |
probes (const word &name, const Time &runTime, const dictionary &dict, const bool loadFromFiles=false, const bool readFields=true) | |
Construct from Time and dictionary. More... | |
virtual | ~probes ()=default |
Destructor. More... | |
bool | verbose (const bool on) noexcept |
Enable/disable verbose output. More... | |
virtual const wordRes & | fieldNames () const noexcept |
Return names of fields to probe. More... | |
virtual const pointField & | probeLocations () const noexcept |
Return locations to probe. More... | |
virtual const point & | probe (const label i) const |
Return location for probe i. More... | |
const labelList & | elements () const noexcept |
Cells to be probed (obtained from the locations) 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 VolumeField< Type > &) const |
Sample a volume field at all locations. More... | |
template<class Type > | |
tmp< Field< Type > > | sample (const SurfaceField< Type > &) const |
Sample a surface field at all locations. More... | |
template<class Type > | |
tmp< Field< Type > > | sample (const word &fieldName) const |
Sample a volume field at all locations. More... | |
template<class Type > | |
tmp< Field< Type > > | sampleSurfaceField (const word &fieldName) const |
Sample a surface field at all locations. More... | |
template<class GeoField > | |
Foam::tmp< GeoField > | getOrLoadField (const word &fieldName) const |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | sample (const VolumeField< Type > &vField) const |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | sample (const SurfaceField< Type > &sField) const |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | sample (const word &fieldName) const |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | sampleSurfaceField (const word &fieldName) const |
Public Member Functions inherited from fvMeshFunctionObject | |
TypeName ("fvMeshFunctionObject") | |
Runtime type information. More... | |
fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
Construct from the region objectRegistry and dictionary. More... | |
virtual | ~fvMeshFunctionObject ()=default |
Destructor. More... | |
Public Member Functions inherited from regionFunctionObject | |
TypeName ("regionFunctionObject") | |
Runtime type information. More... | |
regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
Construct from the region objectRegistry and dictionary. More... | |
virtual | ~regionFunctionObject ()=default |
Destructor. More... | |
template<class ObjectType > | |
const ObjectType * | lookupObjectPtr (const word &fieldName) const |
Deprecated(2018-10) More... | |
template<class ObjectType > | |
ObjectType * | lookupObjectRefPtr (const word &fieldName) const |
Deprecated(2018-10) More... | |
Public Member Functions inherited from stateFunctionObject | |
stateFunctionObject (const word &name, const Time &runTime) | |
Construct from components. More... | |
virtual | ~stateFunctionObject ()=default |
Destructor. More... | |
dictionary & | propertyDict () |
Return access to the property dictionary. More... | |
bool | foundProperty (const word &entryName) const |
Return true if the property exists. More... | |
void | clearTrigger () |
Remove the trigger index from the properties. More... | |
label | getTrigger () const |
Get the current trigger index. More... | |
bool | setTrigger (const label triggeri) |
Set new trigger index. More... | |
bool | getDict (const word &entryName, dictionary &dict) const |
Set dictionary, return true if set. More... | |
bool | getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const |
Set dictionary from named object, return true if set. More... | |
template<class Type > | |
Type | getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const |
Retrieve generic property. More... | |
template<class Type > | |
bool | getProperty (const word &entryName, Type &value) const |
Set generic property, return true if set. More... | |
template<class Type > | |
void | setProperty (const word &entryName, const Type &value) |
Add generic property. More... | |
template<class Type > | |
Type | getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const |
Retrieve generic property from named object. More... | |
template<class Type > | |
bool | getObjectProperty (const word &objectName, const word &entryName, Type &value) const |
Set generic property from named object, return true if set. More... | |
template<class Type > | |
void | setObjectProperty (const word &objectName, const word &entryName, const Type &value) |
Add generic property from named object. More... | |
template<class Type > | |
void | setResult (const word &entryName, const Type &value) |
Add result. More... | |
template<class Type > | |
void | setObjectResult (const word &objectName, const word &entryName, const Type &value) |
Add result from named object. More... | |
template<class Type > | |
Type | getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const |
Retrieve result. More... | |
template<class Type > | |
Type | getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const |
Retrieve result from named object. More... | |
template<class Type > | |
bool | getObjectResult (const word &objectName, const word &entryName, Type &value) const |
Set result from named object, return true if set. More... | |
word | resultType (const word &entryName) const |
Retrieve the result type. More... | |
word | objectResultType (const word &objectName, const word &entryName) const |
Return the type of result. More... | |
wordList | objectResultEntries () const |
Retrieve the result entries. More... | |
wordList | objectResultEntries (const word &objectName) const |
Return result entries for named object. More... | |
void | writeResultEntries (Ostream &os) const |
Write the results entries for all objects to stream. More... | |
void | writeResultEntries (const word &objectName, Ostream &os) const |
Write the results entries for named object to stream. More... | |
void | writeAllResultEntries (Ostream &os) const |
Write the results entries for all objects to stream. More... | |
Public Member Functions inherited from timeFunctionObject | |
timeFunctionObject (const word &name, const Time &runTime) | |
Construct from Time. More... | |
virtual | ~timeFunctionObject ()=default |
Destructor. More... | |
const Time & | time () const |
Return time database. More... | |
objectRegistry & | storedObjects () |
Write access to the output objects ("functionObjectObjects") registered on Time. More... | |
const objectRegistry & | storedObjects () const |
Const access to the output objects ("functionObjectObjects") registered on Time. More... | |
Public Member Functions inherited from functionObject | |
declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict)) | |
functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix) | |
Construct from components. More... | |
autoPtr< functionObject > | clone () const |
Return clone. More... | |
virtual | ~functionObject ()=default |
Destructor. More... | |
virtual const word & | type () const =0 |
Runtime type information. More... | |
const word & | name () const noexcept |
Return the name of this functionObject. More... | |
bool | useNamePrefix () const noexcept |
Return the flag for adding a scoping name prefix. More... | |
bool | useNamePrefix (bool on) noexcept |
Modify the flag for adding a scoping name prefix. More... | |
virtual bool | execute (const label subIndex) |
Execute using the specified subIndex. More... | |
virtual bool | end () |
Called when Time::run() determines that the time-loop exits. More... | |
virtual bool | adjustTimeStep () |
Called at the end of Time::adjustDeltaT() if adjustTime is true. More... | |
virtual bool | filesModified () const |
Did any file get changed during execution? More... | |
Public Member Functions inherited from Field< vector > | |
constexpr | Field () noexcept |
Default construct. More... | |
Field (const label len) | |
Construct given size. More... | |
Field (const label len, const vector &val) | |
Construct given size and initial value. More... | |
Field (const label len, const Foam::zero) | |
Construct given size and initial values of zero. More... | |
Field (const Foam::one, const vector &val) | |
Construct with length=1, copying the value as the only content. More... | |
Field (const Foam::one, vector &&val) | |
Construct with length=1, moving the value as the only content. More... | |
Field (const Foam::one, const Foam::zero) | |
Construct with length=1, initializing content to zero. More... | |
Field (const Field< vector > &fld) | |
Copy construct. More... | |
Field (const UList< vector > &list) | |
Copy construct from UList<Type> More... | |
Field (const IndirectListBase< vector, Addr > &list) | |
Copy construct from IndirectList. More... | |
Field (Field< vector > &&fld) | |
Move construct from Field. More... | |
Field (List< vector > &&list) | |
Move construct from List. More... | |
Field (DynamicList< vector, SizeMin > &&list) | |
Move construct from DynamicList. 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, const bool applyFlip=true) | |
Construct by mapping from the given field. More... | |
Field (const UList< vector > &mapF, const FieldMapper &map, const vector &defaultValue, const bool applyFlip=true) | |
Construct by mapping from the given field. More... | |
Field (const UList< vector > &mapF, const FieldMapper &map, const UList< vector > &defaultValues, const bool applyFlip=true) | |
Construct by mapping from the given field. More... | |
Field (const tmp< Field< vector >> &tmapF, const FieldMapper &map, const bool applyFlip=true) | |
Construct by mapping from the given tmp field. More... | |
Field (const tmp< Field< vector >> &tmapF, const FieldMapper &map, const vector &defaultValue, const bool applyFlip=true) | |
Construct by mapping from the given tmp field. Uses supplied uniform value for unmapped items. More... | |
Field (const tmp< Field< vector >> &tmapF, const FieldMapper &map, const UList< vector > &defaultValues, const bool applyFlip=true) | |
Construct by mapping from the given tmp field. Uses supplied values for unmapped items. More... | |
Field (Field< vector > &fld, bool reuse) | |
Copy construct or re-use as specified. More... | |
Field (const tmp< Field< vector >> &tfld) | |
Copy or move construct from tmp. More... | |
Field (Istream &is) | |
Construct from Istream. More... | |
Field (const entry &e, const label len) | |
Construct from a dictionary (primitive) entry. More... | |
Field (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) | |
Lookup of a primitive dictionary entry by (literal) name and assign its contents to this. The behaviour largely as described in assign(): More... | |
tmp< Field< vector > > | clone () const |
Clone. More... | |
void | assign (const entry &e, const label len) |
Assign from a primitive dictionary entry with the following behaviour: More... | |
bool | assign (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) |
Lookup a primitive dictionary entry by (literal) name and assign its contents to this (behaviour as described above). 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, const bool applyFlip=true) |
Map from the given field. More... | |
void | map (const tmp< Field< vector >> &tmapF, const FieldMapper &map, const bool applyFlip=true) |
Map from the given tmp field. More... | |
void | autoMap (const FieldMapper &map, const bool applyFlip=true) |
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 () |
Inplace negate this field (negative). More... | |
void | normalise () |
Inplace normalise this field. Generally a no-op except for vector fields. More... | |
void | normalise () |
void | normalise () |
void | normalise () |
Inplace normalise (float) vector field. More... | |
void | normalise () |
Inplace normalise (double) vector 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... | |
void | clamp_min (const vector &lower) |
Impose lower (floor) clamp on the field values (in-place) More... | |
void | clamp_max (const vector &upper) |
Impose upper (ceiling) clamp on the field values (in-place) More... | |
void | clamp_range (const vector &lower, const vector &upper) |
Clamp field values (in-place) to the specified range. More... | |
void | clamp_range (const MinMax< vector > &range) |
Clamp field values (in-place) to the specified range. More... | |
VSForm | block (const label start) const |
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... | |
SubField< vector > | slice (const label pos, label len=-1) |
Return SubField slice (non-const access) - no range checking. More... | |
const SubField< vector > | slice (const label pos, label len=-1) const |
Return SubField slice (const access) - no range checking. More... | |
SubField< vector > | slice (const labelRange &range) |
Return SubField slice (non-const access) - with range checking. More... | |
const SubField< vector > | slice (const labelRange &range) const |
Return SubField slice (const access) - with range checking. More... | |
void | operator= (const Field< vector > &) |
Copy assignment. More... | |
void | operator= (const tmp< Field< vector >> &) |
void | operator= (const UList< vector > &rhs) |
void | operator= (const SubField< vector > &rhs) |
void | operator= (const IndirectListBase< vector, Addr > &rhs) |
Copy assign from IndirectList. More... | |
void | operator= (Field< vector > &&rhs) |
Move assignment. More... | |
void | operator= (List< vector > &&rhs) |
void | operator= (DynamicList< vector, SizeMin > &&rhs) |
void | operator= (const vector &val) |
Assign entries to the given value. More... | |
void | operator= (const Foam::zero) |
Assign entries to zero. More... | |
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 FieldBase | |
constexpr | FieldBase () noexcept |
Default construct. More... | |
Public Member Functions inherited from refCount | |
constexpr | refCount () noexcept |
Default construct, initializing count to 0. More... | |
int | use_count () const noexcept |
Return the current reference count. More... | |
bool | unique () const noexcept |
Return true if the reference count is zero. More... | |
void | operator++ () noexcept |
Increment the reference count. More... | |
void | operator++ (int) noexcept |
Increment the reference count. More... | |
void | operator-- () noexcept |
Decrement the reference count. More... | |
void | operator-- (int) noexcept |
Decrement the reference count. More... | |
Public Member Functions inherited from List< vector > | |
constexpr | List () noexcept |
Default construct. More... | |
List (const label len) | |
Construct with given size. More... | |
List (const label len, const vector &val) | |
Construct with given size and value for all elements. More... | |
List (const label len, const Foam::zero) | |
Construct with given size initializing all elements to zero. More... | |
List (const Foam::one, const vector &val) | |
Construct with length=1, copying the value as the only content. More... | |
List (const Foam::one, vector &&val) | |
Construct with length=1, moving the value as the only content. More... | |
List (const Foam::one, const Foam::zero) | |
Construct with length=1, initializing content to zero. More... | |
List (const List< vector > &a) | |
Copy construct from list. More... | |
List (const UList< vector > &a) | |
Copy construct contents from list. More... | |
List (List< vector > &a, bool reuse) | |
Construct as copy or re-use as specified. More... | |
List (const UList< vector > &list, const labelUList &indices) | |
Copy construct subset of list. More... | |
List (const UList< vector > &list, const FixedList< label, N > &indices) | |
Copy construct subset of list. More... | |
List (const FixedList< vector, N > &list) | |
Construct as copy of FixedList<T, N> More... | |
List (const PtrList< vector > &list) | |
Construct as copy of PtrList<T> More... | |
List (const SLList< vector > &list) | |
Construct as copy of SLList<T> More... | |
List (const IndirectListBase< vector, Addr > &list) | |
Construct as copy of IndirectList contents. More... | |
List (std::initializer_list< vector > list) | |
Construct from an initializer list. More... | |
List (List< vector > &&list) | |
Move construct from List. More... | |
List (DynamicList< vector, SizeMin > &&list) | |
Move construct from DynamicList. More... | |
List (SLList< vector > &&list) | |
Move construct from SLList. More... | |
List (Istream &is) | |
Construct from Istream. More... | |
autoPtr< List< vector > > | clone () const |
Clone. More... | |
~List () | |
Destructor. More... | |
void | clear () |
Clear the list, i.e. set size to zero. More... | |
void | resize (const label len) |
Adjust allocated size of list. More... | |
void | resize (const label len, const vector &val) |
Adjust allocated size of list and set val for new elements. More... | |
void | resize (const label newLen) |
void | resize_nocopy (const label len) |
Adjust allocated size of list without necessarily. More... | |
void | setSize (const label n) |
Alias for resize() More... | |
void | setSize (const label n, const vector &val) |
Alias for resize() More... | |
void | transfer (List< vector > &list) |
Transfer the contents of the argument List into this list and annul the argument list. More... | |
void | transfer (DynamicList< vector, SizeMin > &list) |
Transfer the contents of the argument List into this list and annul the argument list. More... | |
vector & | newElmt (const label i) |
Return subscript-checked element of UList and resizing the list if required. More... | |
vector & | emplace_back (Args &&... args) |
Construct an element at the end of the list, return reference to the new list element. More... | |
void | push_back (const vector &val) |
Append an element at the end of the list. More... | |
void | push_back (vector &&val) |
Move append an element at the end of the list. More... | |
void | push_back (const UList< vector > &list) |
Append a List to the end of this list. More... | |
void | push_back (const IndirectListBase< vector, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | push_uniq (const vector &val) |
Append an element if not already in the list. More... | |
void | pop_back (label n=1) |
Reduce size by 1 or more elements. Can be called on an empty list. More... | |
void | operator= (const UList< vector > &a) |
Assignment to UList operator. Takes linear time. More... | |
void | operator= (const List< vector > &list) |
Assignment operator. Takes linear time. More... | |
void | operator= (const SLList< vector > &list) |
Assignment to SLList operator. Takes linear time. More... | |
void | operator= (const IndirectListBase< vector, Addr > &list) |
Assignment from IndirectList. Takes linear time. More... | |
void | operator= (const FixedList< vector, N > &list) |
Copy assignment from FixedList. More... | |
void | operator= (std::initializer_list< vector > list) |
Assignment to an initializer list. More... | |
void | operator= (const vector &val) |
Assignment of all entries to the given value. More... | |
void | operator= (const Foam::zero) |
Assignment of all entries to zero. More... | |
void | operator= (List< vector > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (DynamicList< vector, SizeMin > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (SLList< vector > &&list) |
Move assignment. Takes constant time. More... | |
Istream & | readList (Istream &is) |
Read List from Istream, discarding contents of existing List. More... | |
Istream & | readList (Istream &is) |
Specialized list reading for character lists which always uses binary format. More... | |
Istream & | readList (Istream &is) |
void | shallowCopy (const UList< vector > &)=delete |
No shallowCopy permitted. More... | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | set (const label i, bool val=true) |
A bitSet::set() method for a list of bool. More... | |
void | append (const vector &val) |
Append an element at the end of the list. More... | |
void | append (vector &&val) |
Move append an element at the end of the list. More... | |
void | append (const UList< vector > &list) |
Append a List to the end of this list. More... | |
void | append (const IndirectListBase< vector, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | appendUniq (const vector &val) |
Append an element if not already in the list. More... | |
Public Member Functions inherited from UList< T > | |
UList (const UList< T > &)=default | |
Copy construct. More... | |
constexpr | UList () noexcept |
Default construct, zero-sized and nullptr. More... | |
UList (T *__restrict__ v, const label len) noexcept | |
Construct from components. More... | |
label | fcIndex (const label i) const noexcept |
The forward circular index. The next index in the list which returns to the first at the end of the list. More... | |
label | rcIndex (const label i) const noexcept |
The reverse circular index. The previous index in the list which returns to the last at the beginning of the list. More... | |
const T & | fcValue (const label i) const |
Return forward circular value (ie, next value in the list) More... | |
T & | fcValue (const label i) |
Return forward circular value (ie, next value in the list) More... | |
const T & | rcValue (const label i) const |
Return reverse circular value (ie, previous value in the list) More... | |
T & | rcValue (const label i) |
Return reverse circular value (ie, previous value in the list) More... | |
const T * | cdata () const noexcept |
Return pointer to the underlying array serving as data storage. More... | |
T * | data () noexcept |
Return pointer to the underlying array serving as data storage. More... | |
const char * | cdata_bytes () const noexcept |
Return pointer to the underlying array serving as data storage,. More... | |
char * | data_bytes () noexcept |
Return pointer to the underlying array serving as data storage,. More... | |
T & | front () |
Access first element of the list, position [0]. More... | |
const T & | front () const |
Access first element of the list. More... | |
T & | back () |
Access last element of the list, position [size()-1]. More... | |
const T & | back () const |
Access last element of the list, position [size()-1]. More... | |
std::streamsize | size_bytes () const noexcept |
Number of contiguous bytes for the List data. More... | |
std::streamsize | byteSize () const |
Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More... | |
void | checkStart (const label start) const |
Check start is within valid range [0,size) More... | |
void | checkSize (const label size) const |
Check size is within valid range [0,size]. More... | |
void | checkRange (const label start, const label len) const |
Check that start and length define a valid range. More... | |
void | checkIndex (const label i) const |
Check index is within valid range [0,size) More... | |
bool | uniform () const |
True if all entries have identical values, and list is non-empty. More... | |
label | find (const T &val, label pos=0) const |
Find index of the first occurrence of the value. More... | |
label | rfind (const T &val, label pos=-1) const |
Find index of the last occurrence of the value. More... | |
bool | contains (const T &val, label pos=0) const |
Is the value contained in the list? More... | |
void | moveFirst (const label i) |
Move element to the first position. More... | |
void | moveLast (const label i) |
Move element to the last position. More... | |
void | swapFirst (const label i) |
Swap element with the first element. Fatal on an empty list. More... | |
void | swapLast (const label i) |
Swap element with the last element. Fatal on an empty list. More... | |
void | shallowCopy (const UList< T > &list) |
Copy the pointer and size held by the given UList. More... | |
void | deepCopy (const UList< T > &list) |
Copy elements of the given UList. Sizes must match! More... | |
template<class Addr > | |
void | deepCopy (const IndirectListBase< T, Addr > &list) |
Copy elements of the given indirect list. Sizes must match! More... | |
SubList< T > | slice (const label pos, label len=-1) |
Return SubList slice (non-const access) - no range checking. More... | |
const SubList< T > | slice (const label pos, label len=-1) const |
Return SubList slice (const access) - no range checking. More... | |
SubList< T > | slice (const labelRange &range) |
Return SubList slice (non-const access) - with range checking. More... | |
const SubList< T > | slice (const labelRange &range) const |
Return SubList slice (const access) - with range checking. More... | |
T & | operator[] (const label i) |
Return element of UList. More... | |
const T & | operator[] (const label i) 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 &val) |
Assignment of all entries to the given value. More... | |
void | operator= (const Foam::zero) |
Assignment of all entries to zero. More... | |
iterator | begin () noexcept |
Return an iterator to begin traversing the UList. More... | |
iterator | end () noexcept |
Return an iterator to end traversing the UList. More... | |
iterator | begin (const label i) noexcept |
Return iterator at offset i from begin, clamped to [0,size] range. More... | |
const_iterator | cbegin () const noexcept |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | cend () const noexcept |
Return const_iterator to end traversing the constant UList. More... | |
const_iterator | begin () const noexcept |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | end () const noexcept |
Return const_iterator to end traversing the constant UList. More... | |
const_iterator | cbegin (const label i) const noexcept |
Return const_iterator at offset i from begin, clamped to [0,size] range. More... | |
const_iterator | begin (const label i) const noexcept |
Return const_iterator at offset i from begin, clamped to [0,size] range. 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... | |
bool | empty () const noexcept |
True if List is empty (ie, size() is zero) More... | |
label | size () const noexcept |
The number of elements in the List. More... | |
void | swap (UList< T > &list) |
Swap content with another UList of the same type in constant time. More... | |
bool | operator== (const UList< T > &a) const |
Equality operation on ULists of the same type. More... | |
bool | operator!= (const UList< T > &a) const |
The opposite of the equality operation. Takes linear time. More... | |
bool | operator< (const UList< T > &list) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator> (const UList< T > &a) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator<= (const UList< T > &a) const |
Return true if !(a > b). Takes linear time. More... | |
bool | operator>= (const UList< T > &a) const |
Return true if !(a < b). Takes linear time. More... | |
Istream & | readList (Istream &is) |
Read List contents from Istream. More... | |
void | writeEntry (const word &keyword, Ostream &os) const |
Write the List as a dictionary entry with keyword. More... | |
Ostream & | writeList (Ostream &os, const label shortLen=0) const |
Write List, with line-breaks in ASCII when length exceeds shortLen. More... | |
template<class TypeT = T> | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | test (const label i) const |
Test bool value at specified position, always false for out-of-range access. More... | |
template<class TypeT = T> | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | get (const label i) const |
Return bool value at specified position, always false for out-of-range access. More... | |
template<class TypeT = T> | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | unset (const label i) |
Unset the bool entry at specified position, always false for out-of-range access. More... | |
T & | first () |
Access first element of the list, position [0]. More... | |
const T & | first () const |
Access first element of the list. More... | |
T & | last () |
Access last element of the list, position [size()-1]. More... | |
const T & | last () const |
Access last element of the list, position [size()-1]. More... | |
bool | found (const T &val, label pos=0) const |
Same as contains() More... | |
template<> | |
Istream & | readList (Istream &is) |
Specialized list reading for character lists which always uses binary format. More... | |
template<> | |
Ostream & | writeList (Ostream &os, const label) const |
Specialized writeList for character lists which always uses binary format. More... | |
template<> | |
const bool & | operator[] (const label i) const |
template<> | |
UPstream::commsStruct & | operator[] (const label procID) |
template<> | |
const UPstream::commsStruct & | operator[] (const label procID) const |
template<> | |
Foam::UPstream::commsStruct & | operator[] (const label procID) |
template<> | |
const Foam::UPstream::commsStruct & | operator[] (const label procID) const |
template<> | |
Ostream & | writeList (Ostream &os, const label) const |
template<> | |
Istream & | readList (Istream &is) |
Public Member Functions inherited from ODESystem | |
ODESystem () | |
Construct null. More... | |
virtual | ~ODESystem ()=default |
Destructor. More... | |
Protected Attributes | |
scalar | rho_ |
Thermocouple density. More... | |
scalar | Cp_ |
Thermocouple heat capacity. More... | |
scalar | d_ |
Thermocouple diameter. More... | |
scalar | epsilon_ |
Thermocouple emissivity. More... | |
word | UName_ |
Name of the velocity field. More... | |
word | radiationFieldName_ |
Name of the incident radiation field. More... | |
const fluidThermo & | thermo_ |
Fluid thermo reference. More... | |
autoPtr< ODESolver > | odeSolver_ |
ODESolver. More... | |
scalarField | Ttc_ |
Cached thermocouple temperature. More... | |
Protected Attributes inherited from probes | |
bool | loadFromFiles_ |
Load fields from files (not from objectRegistry) More... | |
bool | fixedLocations_ |
Fixed locations (default: true) More... | |
bool | includeOutOfBounds_ |
Include probes that were not found (default: true) More... | |
bool | verbose_ |
Output verbosity. More... | |
bool | onExecute_ |
Perform sample actions on execute as well. More... | |
wordRes | fieldSelection_ |
Requested names of fields to probe. More... | |
word | samplePointScheme_ |
Interpolation/sample scheme to obtain values at the points. More... | |
DynamicList< word > | selectedFieldNames_ |
Current list of field names selected for sampling. More... | |
fieldGroup< volScalarField > | scalarFields_ |
Categorized scalar/vector/tensor volume fields. More... | |
fieldGroup< volVectorField > | vectorFields_ |
fieldGroup< volSphericalTensorField > | sphericalTensorFields_ |
fieldGroup< volSymmTensorField > | symmTensorFields_ |
fieldGroup< volTensorField > | tensorFields_ |
fieldGroup< surfaceScalarField > | surfaceScalarFields_ |
Categorized scalar/vector/tensor surface fields. More... | |
fieldGroup< surfaceVectorField > | surfaceVectorFields_ |
fieldGroup< surfaceSphericalTensorField > | surfaceSphericalTensorFields_ |
fieldGroup< surfaceSymmTensorField > | surfaceSymmTensorFields_ |
fieldGroup< surfaceTensorField > | surfaceTensorFields_ |
labelList | elementList_ |
Cells to be probed (obtained from the locations) More... | |
labelList | faceList_ |
Faces to be probed. More... | |
labelList | processor_ |
Processor holding the cell or face (-1 if point not found. More... | |
HashPtrTable< OFstream > | probeFilePtrs_ |
Current open files (non-empty on master only) More... | |
labelList | patchIDList_ |
Patch IDs on which the new probes are located (for patchProbes) More... | |
pointField | oldPoints_ |
Original probes location (only used for patchProbes) More... | |
Protected Attributes inherited from fvMeshFunctionObject | |
const fvMesh & | mesh_ |
Reference to the fvMesh. More... | |
Protected Attributes inherited from regionFunctionObject | |
word | subRegistryName_ |
Name for alternative object registry. More... | |
const objectRegistry & | obr_ |
Reference to the region objectRegistry. More... | |
const objectRegistry * | obrPtr_ |
Pointer to alternative (eg, sub-region) objectRegistry. More... | |
Protected Attributes inherited from timeFunctionObject | |
const Time & | time_ |
Reference to the time database. More... | |
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< vector > | |
typedef SubList< vector > | subList |
Declare type of subList. More... | |
Public Types inherited from UList< T > | |
typedef T | value_type |
The value type the list contains. More... | |
typedef T * | pointer |
The pointer type for non-const access to value_type items. More... | |
typedef const T * | const_pointer |
The pointer type for const access to value_type items. More... | |
typedef T & | reference |
The type used for storing into value_type objects. More... | |
typedef const T & | const_reference |
The type used for reading from constant value_type objects. More... | |
typedef T * | iterator |
Random access iterator for traversing a UList. More... | |
typedef const T * | const_iterator |
Random access iterator for traversing a UList. More... | |
typedef label | size_type |
The type to represent the size of a UList. More... | |
typedef label | difference_type |
The difference between iterator objects. More... | |
typedef std::reverse_iterator< iterator > | reverse_iterator |
Reverse iterator (non-const access) More... | |
typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
Reverse iterator (const access) More... | |
Static Public Member Functions inherited from functionObject | |
static autoPtr< functionObject > | New (const word &name, const Time &runTime, const dictionary &dict) |
Select from dictionary, based on its "type" entry. More... | |
Static Public Member Functions inherited from Field< vector > | |
static const Field< vector > & | null () |
Return nullObject reference Field. More... | |
static autoPtr< Field< vector > > | New (Istream &is) |
Return a pointer to a new Field created on freestore. More... | |
static tmp< Field< vector > > | NewCalculatedType (const Field< Type2 > &f) |
Return a pointer to a new calculatedFvPatchFieldField created on freestore without setting patchField values. 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 UList reference to a nullObject. More... | |
static constexpr label | max_size () noexcept |
The size of the largest possible UList. More... | |
Public Attributes inherited from functionObject | |
bool | log |
Flag to write log into Info. More... | |
Static Public Attributes inherited from functionObject | |
static int | debug |
Flag to execute debug content. More... | |
static bool | postProcess |
Global post-processing mode switch. More... | |
static bool | defaultUseNamePrefix |
Global default for useNamePrefix. More... | |
static word | outputPrefix |
Directory prefix. More... | |
Static Public Attributes inherited from FieldBase | |
static const char *const | typeName |
Typename for Field. More... | |
static bool | allowConstructFromLargerSize = false |
Permit read construct from a larger size. More... | |
Protected Types inherited from probes | |
enum | sampleActionType : unsigned { ACTION_NONE = 0, ACTION_WRITE = 0x1, ACTION_STORE = 0x2, ACTION_ALL = 0xF } |
Local control for sampling actions. More... | |
Protected Member Functions inherited from probes | |
virtual void | findElements (const fvMesh &mesh) |
Find cells and faces containing probes. More... | |
label | prepare (unsigned request) |
Classify field types, close/open file streams. More... | |
template<class GeoField > | |
tmp< GeoField > | getOrLoadField (const word &fieldName) const |
Get from registry or load from disk. More... | |
template<class Type > | |
void | storeResults (const word &fieldName, const Field< Type > &values) |
Store results: min/max/average/size. More... | |
Protected Member Functions inherited from fvMeshFunctionObject | |
fvMeshFunctionObject (const fvMeshFunctionObject &)=delete | |
No copy construct. More... | |
void | operator= (const fvMeshFunctionObject &)=delete |
No copy assignment. More... | |
Protected Member Functions inherited from regionFunctionObject | |
virtual const objectRegistry & | obr () const |
The region or sub-region registry being used. More... | |
template<class ObjectType > | |
bool | foundObject (const word &fieldName) const |
Find object (eg, a field) in the (sub) objectRegistry. More... | |
template<class ObjectType > | |
const ObjectType * | cfindObject (const word &fieldName) const |
Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More... | |
template<class ObjectType > | |
const ObjectType * | findObject (const word &fieldName) const |
Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More... | |
template<class ObjectType > | |
ObjectType * | findObject (const word &fieldName) |
Return non-const pointer to the object of the given Type, (sub) objectRegistry. More... | |
template<class ObjectType > | |
ObjectType * | getObjectPtr (const word &fieldName) const |
Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable. More... | |
template<class ObjectType > | |
const ObjectType & | lookupObject (const word &fieldName) const |
Lookup and return object (eg, a field) from the (sub) objectRegistry. More... | |
template<class ObjectType > | |
ObjectType & | lookupObjectRef (const word &fieldName) const |
Lookup and return object (eg, a field) from the (sub) objectRegistry. More... | |
template<class ObjectType > | |
bool | store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false) |
Store the field in the (sub) objectRegistry under the given name. More... | |
template<class ObjectType > | |
bool | storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr) |
Store the field in an optional objectRegistry under the given name. More... | |
bool | writeObject (const word &fieldName) |
Write field if present in the (sub) objectRegistry. More... | |
bool | clearObject (const word &fieldName) |
Clear field from the (sub) objectRegistry if present. More... | |
void | clearObjects (const wordList &objNames) |
Clear fields from the (sub) objectRegistry if present. More... | |
regionFunctionObject (const regionFunctionObject &)=delete | |
No copy construct. More... | |
void | operator= (const regionFunctionObject &)=delete |
No copy assignment. More... | |
Protected Member Functions inherited from stateFunctionObject | |
const functionObjects::properties & | stateDict () const |
Return a const reference to the state dictionary. More... | |
functionObjects::properties & | stateDict () |
Return non-const access to the state dictionary. More... | |
stateFunctionObject (const stateFunctionObject &)=delete | |
No copy construct. More... | |
void | operator= (const stateFunctionObject &)=delete |
No copy assignment. More... | |
Protected Member Functions inherited from timeFunctionObject | |
void | clearOutputObjects (const wordList &objNames) |
Remove specified items from "functionObjectObjects". More... | |
timeFunctionObject (const timeFunctionObject &)=delete | |
No copy construct. More... | |
void | operator= (const timeFunctionObject &)=delete |
No copy assignment. More... | |
Protected Member Functions inherited from functionObject | |
word | scopedName (const word &name) const |
Return a scoped (prefixed) name. More... | |
Protected Member Functions inherited from UList< T > | |
void | setAddressableSize (const label n) noexcept |
Set addressed size to be inconsistent with allocated storage. More... | |
void | size (const label n) |
Older name for setAddressableSize. More... | |
void | writeEntry (Ostream &os) const |
Write the UList with its compound type. More... | |
labelRange | validateRange (const labelRange &requestedRange) const |
Return a validated (start,size) subset range, which means that it always addresses a valid section of the list. More... | |
UList< T > & | operator= (const UList< T > &)=delete |
No copy assignment (default: shallow copy) More... | |
template<> | |
void | writeEntry (Ostream &os) const |
Specialized writeEntry for character lists which always uses binary format. More... | |
template<> | |
void | writeEntry (Ostream &os) const |
Sample probe for temperature using a thermocouple.
probes { type thermoCoupleProbes; libs (utilityFunctionObjects); writeControl timeStep; writeInterval 1; solver rodas23; absTol 1e-12; relTol 1e-8; interpolationScheme cellPoint; // thermocouple properties rho 8908; Cp 440; d 1e-3; epsilon 0.85; radiationField G; probeLocations ( (0.5 0.5 0.5) ); fields ( T ); }
Definition at line 97 of file thermoCoupleProbes.H.
thermoCoupleProbes | ( | const word & | name, |
const Time & | runTime, | ||
const dictionary & | dict, | ||
const bool | loadFromFiles = false , |
||
const bool | readFields = true |
||
) |
Construct for given objectRegistry and dictionary.
Allow the possibility to load fields from files
Definition at line 43 of file thermoCoupleProbes.C.
References dict, ODESolver::New(), Foam::read(), dictionary::readEntry(), and probes::sample().
|
virtualdefault |
Destructor.
TypeName | ( | "thermoCoupleProbes" | ) |
Runtime type information.
|
virtual |
|
virtual |
Calculate the derivatives in dydx.
Implements ODESystem.
Definition at line 90 of file thermoCoupleProbes.C.
References Foam::fieldTypes::area, Foam::constant::universal::G, Foam::mag(), Foam::max(), Foam::constant::mathematical::pi(), Foam::pow(), Foam::pow3(), Foam::pow4(), Pr(), Foam::Re(), probes::sample(), sigma(), Foam::constant::physicoChemical::sigma, Foam::sqr(), Foam::sqrt(), dimensioned< Type >::value(), Foam::fieldTypes::volume, y, and Foam::Zero.
|
virtual |
|
virtual |
Read.
Reimplemented from probes.
Definition at line 190 of file thermoCoupleProbes.C.
References dict, and probes::read().
|
virtual |
Execute. Evaluates the ODESolver.
Reimplemented from probes.
Definition at line 176 of file thermoCoupleProbes.C.
References UList< T >::empty().
|
virtual |
Sample and write.
Reimplemented from probes.
Definition at line 157 of file thermoCoupleProbes.C.
References dictionary::add(), and UList< T >::empty().
|
protected |
Thermocouple density.
Definition at line 109 of file thermoCoupleProbes.H.
|
protected |
Thermocouple heat capacity.
Definition at line 114 of file thermoCoupleProbes.H.
|
protected |
Thermocouple diameter.
Definition at line 119 of file thermoCoupleProbes.H.
|
protected |
Thermocouple emissivity.
Definition at line 124 of file thermoCoupleProbes.H.
|
protected |
Name of the velocity field.
Definition at line 129 of file thermoCoupleProbes.H.
|
protected |
Name of the incident radiation field.
Definition at line 134 of file thermoCoupleProbes.H.
|
protected |
Fluid thermo reference.
Definition at line 139 of file thermoCoupleProbes.H.
Definition at line 144 of file thermoCoupleProbes.H.
|
protected |
Cached thermocouple temperature.
Definition at line 149 of file thermoCoupleProbes.H.
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.