The OpenFOAM Foundation
Kmesh Class Reference

Calculate the wavenumber vector field corresponding to the space vector field of a finite volume mesh;. More...

Inheritance diagram for Kmesh:
[legend]
Collaboration diagram for Kmesh:
[legend]

Public Member Functions

Kmesh (const fvMesh &)
Construct from fvMesh. More...

const vectorsizeOfBox () const

const labelListnn () const

scalar max () 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 label, const zero)
Construct given size and initialed to zero. More...

Field (const UList< vector > &)
Construct as copy of a UList<Type> More...

Field (const UIndirectList< vector > &)
Construct as copy of a UIndirectList<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, 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. Supplied uniform. 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. 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, 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 ()
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 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 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< vector >
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 label, const zero)
Construct with given size initializing all elements to zero. More...

List (const List< vector > &)
Copy constructor. More...

List (const List< T2 > &)
Copy constructor from list containing another type. 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 (std::initializer_list< vector >)
Construct from an initializer list. More...

List (Istream &)
Construct from Istream. More...

label size () const
Return the number of elements in the UList. 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 shallowCopy (const UList< vector > &)=delete
Disallow implicit shallowCopy. More...

void operator= (const UList< vector > &)
Assignment to UList operator. Takes linear time. More...

void operator= (const List< vector > &)
Assignment operator. Takes linear time. More...

void operator= (const SLList< vector > &)
Assignment to SLList operator. Takes linear time. More...

void operator= (const UIndirectList< vector > &)
Assignment to UIndirectList operator. Takes linear time. More...

void operator= (const BiIndirectList< vector > &)
Assignment to BiIndirectList operator. Takes linear time. More...

void operator= (std::initializer_list< vector >)
Assignment to an initializer list. More...

void operator= (const vector &)
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...

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 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...

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...

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...

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...

template<>
const bool & operator[] (const label i) const

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 refCount
refCount ()
Construct null initializing count to 0. More...

Protected Member Functions inherited from List< vector >
void size (const label)
Override size to be inconsistent with allocated storage. More...

Detailed Description

Calculate the wavenumber vector field corresponding to the space vector field of a finite volume mesh;.

Source files

Definition at line 49 of file Kmesh.H.

◆ Kmesh()

 Kmesh ( const fvMesh & mesh )

Construct from fvMesh.

Definition at line 47 of file Kmesh.C.

Here is the call graph for this function:

◆ sizeOfBox()

 const vector& sizeOfBox ( ) const
inline

Definition at line 89 of file Kmesh.H.

Referenced by Foam::kShellIntegration().

Here is the caller graph for this function:

◆ nn()

 const labelList& nn ( ) const
inline

Definition at line 94 of file Kmesh.H.

Referenced by Foam::calcEk(), and Foam::kShellIntegration().

Here is the caller graph for this function:

◆ max()

 scalar max ( ) const
inline

Definition at line 99 of file Kmesh.H.

Referenced by Foam::kShellMean().

Here is the caller graph for this function:

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