Public Member Functions | Private Attributes
sampledSets::volFieldSampler< Type > Class Template Reference

Class used for sampling volFields. More...

Inheritance diagram for sampledSets::volFieldSampler< Type >:
Inheritance graph
[legend]
Collaboration diagram for sampledSets::volFieldSampler< Type >:
Collaboration graph
[legend]

Public Member Functions

 volFieldSampler (const word &interpolationScheme, const GeometricField< Type, fvPatchField, volMesh > &field, const PtrList< sampledSet > &)
 Construct interpolating field to the sampleSets. More...
 
 volFieldSampler (const GeometricField< Type, fvPatchField, volMesh > &field, const PtrList< sampledSet > &)
 Construct mapping field to the sampleSets. More...
 
 volFieldSampler (const List< Field< Type > > &values, const word &name)
 Construct from components. More...
 
const wordname () const
 Return the field name. More...
 
- Public Member Functions inherited from List< Field< Type > >
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 T &)
 Construct with given size and value for all elements. More...
 
 List (const List< T > &)
 Copy constructor. More...
 
 List (const Xfer< List< T > > &)
 Construct by transferring the parameter contents. 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...
 
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators. More...
 
 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 (Istream &)
 Construct from Istream. More...
 
 List (const label s)
 
 List (const label s, const T &a)
 
 List (const List< T > &a)
 
 List (const Xfer< List< T > > &lst)
 
 List (List< T > &a, bool reUse)
 
 List (const UList< T > &a, const labelUList &map)
 
 List (const PtrList< T > &lst)
 
 List (const SLList< T > &lst)
 
 List (const UIndirectList< T > &lst)
 
 List (const BiIndirectList< T > &lst)
 
 List ()
 
 List (Istream &is)
 
autoPtr< List< T > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. 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...
 
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...
 
void transfer (List< T > &a)
 
void transfer (SortableList< T > &a)
 
Xfer< List< T > > xfer ()
 Transfer contents to the Xfer container. More...
 
TnewElmt (const label)
 Return subscript-checked element of UList. More...
 
void operator= (const UList< T > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const List< T > &)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< T > &)
 Assignment from SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< T > &)
 Assignment from UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< T > &)
 Assignment from BiIndirectList operator. Takes linear time. More...
 
void operator= (const T &)
 Assignment of all entries to the given value. More...
 

Private Attributes

const word name_
 Name of this collection of values. More...
 

Additional Inherited Members

- Public Types inherited from List< Field< Type > >
typedef SubList< TsubList
 Declare type of subList. More...
 
- Static Public Member Functions inherited from List< Field< Type > >
static const List< T > & null ()
 Return a null List. More...
 
- Protected Member Functions inherited from List< Field< Type > >
void size (const label)
 Override size to be inconsistent with allocated storage. More...
 

Detailed Description

template<class Type>
class Foam::sampledSets::volFieldSampler< Type >

Class used for sampling volFields.

Definition at line 110 of file sampledSets.H.

Constructor & Destructor Documentation

◆ volFieldSampler() [1/3]

volFieldSampler ( const word interpolationScheme,
const GeometricField< Type, fvPatchField, volMesh > &  field,
const PtrList< sampledSet > &  samplers 
)

Construct interpolating field to the sampleSets.

Definition at line 34 of file sampledSetsTemplates.C.

References forAll, and samples().

Here is the call graph for this function:

◆ volFieldSampler() [2/3]

volFieldSampler ( const GeometricField< Type, fvPatchField, volMesh > &  field,
const PtrList< sampledSet > &  samplers 
)

Construct mapping field to the sampleSets.

Definition at line 81 of file sampledSetsTemplates.C.

References forAll, and samples().

Here is the call graph for this function:

◆ volFieldSampler() [3/3]

volFieldSampler ( const List< Field< Type > > &  values,
const word name 
)

Construct from components.

Definition at line 114 of file sampledSetsTemplates.C.

Member Function Documentation

◆ name()

const word& name ( ) const
inline

Return the field name.

Definition at line 142 of file sampledSets.H.

References sampledSets::volFieldSampler< Type >::name_.

Field Documentation

◆ name_

const word name_
private

Name of this collection of values.

Definition at line 115 of file sampledSets.H.

Referenced by sampledSets::volFieldSampler< Type >::name().


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