FreeFOAM The Cross-Platform CFD Toolkit
referredCell Class Reference

#include <molecule/referredCell.H>


Detailed Description

+ Inheritance diagram for referredCell:
+ Collaboration diagram for referredCell:

List of all members.

Public Member Functions

 referredCell ()
 Construct null.
 referredCell (const polyMesh &mesh, const label sourceProc, const label sourceCell, const vector &offset, const tensor &rotation)
 Construct from components with external edge information.
 referredCell (const label sourceProc, const label sourceCell, const vectorList &vertexPositions, const edgeList &localEdges, const labelListList &localFaces, const vectorList &faceCentres, const vectorList &faceAreas, const vector &offset, const tensor &rotation)
 Construct from components with existing local edge information.
 referredCell (const polyMesh &mesh, const label sourceProc, const label sourceCell, const vector &cS, const vector &cD, const vector &nS, const vector &nD)
 Construct from pair of face centers (c) and plain.
virtual ~referredCell ()
referredCell reRefer (const vector &cS, const vector &cD, const vector &nS, const vector &nD)
 Take this referredCell object that has already had it's transform.
vector referPosition (const vector &positionToRefer) const
 Use internal transformatation values to transform the given.
vectorList referPosition (const vectorList &positionsToRefer) const
 Use internal transformatation values to transform the given.
vector rotateVector (const vector &vectorToRotate) const
 Use internal transformatation values to rotate the given vector.
vectorList rotateVectors (const vectorList &vectorsToRotate) const
 Use internal transformatation values to rotate the given.
void referInMols (const List< referredMolecule > &incomingMols)
 referInMols clears, the stored list of referred mols and takes
bool duplicate (const referredCell &refCellDupl) const
 duplicate() function to test whether a referred or real cell
bool duplicate (const label procNo, const label nCells) const
label sourceProc () const
label sourceCell () const
const vectoroffset () const
const tensorrotation () const
const vectorListvertexPositions () const
const edgeListedges () const
const labelListListfaces () const
const vectorListfaceCentres () const
const vectorListfaceAreas () const
labelListrealCells ()
const labelListrealCellsForInteraction () const
- Public Member Functions inherited from DynamicList< referredMolecule >
 DynamicList ()
 Construct null.
 DynamicList (const label)
 Construct given size.
 DynamicList (const DynamicList< referredMolecule, 0, 2, 1 > &)
 Construct copy.
 DynamicList (const UList< referredMolecule > &)
 Construct from UList. Size set to UList size.
 DynamicList (const UIndirectList< referredMolecule > &)
 Construct from UIndirectList. Size set to UIndirectList size.
 DynamicList (const Xfer< List< referredMolecule > > &)
 Construct by transferring the parameter contents.
 DynamicList (Istream &)
 Construct from Istream. Size set to size of read list.
label capacity () const
 Size of the underlying storage.
void setCapacity (const label)
 Alter the size of the underlying storage.
void setSize (const label)
 Alter the addressed list size.
void setSize (const label, const referredMolecule &)
 Alter the addressed list size and fill new space with a constant.
void resize (const label)
 Alter the addressed list size.
void resize (const label, const referredMolecule &)
 Alter the addressed list size and fill new space with a constant.
void reserve (const label)
 Reserve allocation space for at least this size.
void clear ()
 Clear the addressed list, i.e. set the size to zero.
void clearStorage ()
 Clear the list and delete storage.
DynamicList< referredMolecule, 0, 2, 1 > & shrink ()
 Shrink the allocated space to the number of elements used.
void transfer (List< referredMolecule > &)
 Transfer contents of the argument List into this DynamicList.
void transfer (DynamicList< referredMolecule, 0, 2, 1 > &)
 Transfer contents of the argument DynamicList into this DynamicList.
Xfer< List< referredMolecule > > xfer ()
 Transfer contents to the Xfer container as a plain List.
void append (const referredMolecule &)
 Append an element at the end of the list.
void append (const UList< referredMolecule > &)
 Append a List at the end of this list.
void append (const UIndirectList< referredMolecule > &)
 Append a UIndirectList at the end of this list.
referredMolecule remove ()
 Remove and return the top element.
referredMoleculeoperator() (const label)
 Return non-const access to an element, resizing list if necessary.
void operator= (const referredMolecule &)
 Assignment of all addressed entries to the given value.
void operator= (const DynamicList< referredMolecule, 0, 2, 1 > &)
 Assignment from DynamicList.
void operator= (const UList< referredMolecule > &)
 Assignment from UList.
- Public Member Functions inherited from List< referredMolecule >
label size () const
 Return the number of elements in the UList.
 List ()
 Null constructor.
 List (const label)
 Construct with given size.
 List (const label, const referredMolecule &)
 Construct with given size and value for all elements.
 List (const List< referredMolecule > &)
 Copy constructor.
 List (const Xfer< List< referredMolecule > > &)
 Construct by transferring the parameter contents.
 List (List< referredMolecule > &, bool reUse)
 Construct as copy or re-use as specified.
 List (const UList< referredMolecule > &, const unallocLabelList &mapAddressing)
 Construct as subset.
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators.
 List (const FixedList< referredMolecule, Size > &)
 Construct as copy of FixedList<T, Size>
 List (const PtrList< referredMolecule > &)
 Construct as copy of PtrList<T>
 List (const SLList< referredMolecule > &)
 Construct as copy of SLList<T>
 List (const IndirectList< referredMolecule > &)
 Construct as copy of IndirectList<T>
 List (const UIndirectList< referredMolecule > &)
 Construct as copy of UIndirectList<T>
 List (const BiIndirectList< referredMolecule > &)
 Construct as copy of BiIndirectList<T>
 List (Istream &)
 Construct from Istream.
autoPtr< List< referredMolecule > > clone () const
 Clone.
 ~List ()
void transfer (DynamicList< referredMolecule, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list.
void transfer (SortableList< referredMolecule > &)
 Transfer the contents of the argument List into this list.
referredMoleculenewElmt (const label)
 Return subscript-checked element of UList.
void operator= (const List< referredMolecule > &)
 Assignment operator. Takes linear time.
void operator= (const SLList< referredMolecule > &)
 Assignment from SLList operator. Takes linear time.
void operator= (const IndirectList< referredMolecule > &)
 Assignment from IndirectList operator. Takes linear time.
void operator= (const UIndirectList< referredMolecule > &)
 Assignment from UIndirectList operator. Takes linear time.
void operator= (const BiIndirectList< referredMolecule > &)
 Assignment from BiIndirectList operator. Takes linear time.
- Public Member Functions inherited from UList< referredMolecule >
 UList ()
 Null constructor.
 UList (referredMolecule *__restrict__ v, label size)
 Construct from components.
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index.
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index.
label byteSize () const
 Return the binary size in number of characters of the UList.
const referredMoleculecdata () const
 Return a const pointer to the first data element,.
referredMoleculedata ()
 Return a pointer to the first data element,.
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1).
void checkSize (const label size) const
 Check size is within valid range (0 ... size).
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1).
void writeEntry (Ostream &) const
 Write the UList as a dictionary entry.
void writeEntry (const word &keyword, Ostream &) const
 Write the UList as a dictionary entry with keyword.
void assign (const UList< referredMolecule > &)
 Assign elements to those from UList.
referredMoleculeoperator[] (const label)
 Return element of UList.
const referredMoleculeoperator[] (const label) const
 Return element of constant UList.
 operator const Foam::List< referredMolecule > & () const
 Allow cast to a const List<T>&.
iterator begin ()
 Return an iterator to begin traversing the UList.
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList.
iterator end ()
 Return an iterator to end traversing the UList.
const_iterator end () const
 Return const_iterator to end traversing the constant UList.
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant UList.
const_iterator cend () const
 Return const_iterator to end traversing the constant UList.
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList.
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing the UList.
label max_size () const
 Return size of the largest possible UList.
bool empty () const
 Return true if the UList is empty (ie, size() is zero).
void swap (UList< referredMolecule > &)
 Swap two ULists of the same type in constant time.
bool operator== (const UList< referredMolecule > &) const
 Equality operation on ULists of the same type.
bool operator!= (const UList< referredMolecule > &) const
 The opposite of the equality operation. Takes linear time.
bool operator< (const UList< referredMolecule > &) const
 Compare two ULists lexicographically. Takes linear time.
bool operator> (const UList< referredMolecule > &) const
 Compare two ULists lexicographically. Takes linear time.
bool operator<= (const UList< referredMolecule > &) const
 Return true if !(a > b). Takes linear time.
bool operator>= (const UList< referredMolecule > &) const
 Return true if !(a < b). Takes linear time.

Friends

bool operator== (const referredCell &a, const referredCell &b)
bool operator!= (const referredCell &a, const referredCell &b)
Istreamoperator>> (Istream &, referredCell &)
Ostreamoperator<< (Ostream &, const referredCell &)

Constructor & Destructor Documentation

Construct null.

Definition at line 188 of file referredCell.C.

referredCell ( const polyMesh mesh,
const label  sourceProc,
const label  sourceCell,
const vector offset,
const tensor rotation 
)

Construct from components with external edge information.

Definition at line 200 of file referredCell.C.

referredCell ( const label  sourceProc,
const label  sourceCell,
const vectorList vertexPositions,
const edgeList localEdges,
const labelListList localFaces,
const vectorList faceCentres,
const vectorList faceAreas,
const vector offset,
const tensor rotation 
)

Construct from components with existing local edge information.

Definition at line 219 of file referredCell.C.

referredCell ( const polyMesh mesh,
const label  sourceProc,
const label  sourceCell,
const vector cS,
const vector cD,
const vector nS,
const vector nD 
)

Construct from pair of face centers (c) and plain.

face normals (n) (no need to make unit vectors or reverse one direction) Order of vectors important (S = source, D = Destination). External edge information.

Definition at line 252 of file referredCell.C.

References Foam::mag(), and Foam::rotationTensor().

~referredCell ( )
virtual

Definition at line 288 of file referredCell.C.


Member Function Documentation

referredCell reRefer ( const vector cS,
const vector cD,
const vector nS,
const vector nD 
)

Take this referredCell object that has already had it's transform.

calculated and refer it on again, retaining same source info.

Definition at line 295 of file referredCell.C.

References Foam::mag(), and Foam::rotationTensor().

vector referPosition ( const vector positionToRefer) const

Use internal transformatation values to transform the given.

postion to its new location.

Definition at line 328 of file referredCell.C.

vectorList referPosition ( const vectorList positionsToRefer) const

Use internal transformatation values to transform the given.

list of postions to their new locations.

Definition at line 335 of file referredCell.C.

vector rotateVector ( const vector vectorToRotate) const

Use internal transformatation values to rotate the given vector.

Definition at line 343 of file referredCell.C.

vectorList rotateVectors ( const vectorList vectorsToRotate) const

Use internal transformatation values to rotate the given.

list of vectors

Definition at line 349 of file referredCell.C.

void referInMols ( const List< referredMolecule > &  incomingMols)

referInMols clears, the stored list of referred mols and takes

in a list of referred mols coming from a source processor, transformingtheir positions

Definition at line 355 of file referredCell.C.

References DynamicList< referredMolecule >::append(), DynamicList< referredMolecule >::clear(), forAll, and DynamicList< referredMolecule >::shrink().

Referenced by referredCellList::referMolecules().

bool duplicate ( const referredCell refCellDupl) const

duplicate() function to test whether a referred or real cell

supplied by arguement is a duplicate of this referredCell. Can be used bi-directionally - i.e. can be called on an existing referred cell with a proposed referredCell as argument, or vice versa. Can only be called by a proposed referredCell with a real cell index as arguement to test to see if the proposed referredCell is a duplicate. A duplicate cell is defined as one which has the same source processor, source cell, and an equal offset. Real cells have zero offset by definition.

Definition at line 382 of file referredCell.C.

References Foam::mag(), referredCell::offset(), referredCell::sourceCell(), referredCell::sourceProc(), and interactionLists::transTol.

bool duplicate ( const label  procNo,
const label  nCells 
) const

Definition at line 393 of file referredCell.C.

References Foam::mag(), and interactionLists::transTol.

label sourceProc ( ) const
inline

Definition at line 31 of file referredCellI.H.

Referenced by referredCell::duplicate(), and Foam::operator<<().

label sourceCell ( ) const
inline

Definition at line 37 of file referredCellI.H.

Referenced by referredCell::duplicate(), and Foam::operator<<().

const vector & offset ( ) const
inline

Definition at line 43 of file referredCellI.H.

Referenced by referredCell::duplicate(), and Foam::operator<<().

const tensor & rotation ( ) const
inline

Definition at line 49 of file referredCellI.H.

Referenced by Foam::operator<<().

const vectorList & vertexPositions ( ) const
inline

Definition at line 55 of file referredCellI.H.

Referenced by Foam::operator<<(), and interactionLists::testPointFaceDistance().

const edgeList & edges ( ) const
inline

Definition at line 61 of file referredCellI.H.

Referenced by Foam::operator<<().

const labelListList & faces ( ) const
inline

Definition at line 67 of file referredCellI.H.

Referenced by Foam::operator<<(), and interactionLists::testPointFaceDistance().

const vectorList & faceCentres ( ) const
inline

Definition at line 73 of file referredCellI.H.

Referenced by Foam::operator<<(), and interactionLists::testPointFaceDistance().

const vectorList & faceAreas ( ) const
inline

Definition at line 79 of file referredCellI.H.

Referenced by Foam::operator<<(), and interactionLists::testPointFaceDistance().

labelList & realCells ( )
inline

Definition at line 85 of file referredCellI.H.

const labelList & realCellsForInteraction ( ) const
inline

Definition at line 91 of file referredCellI.H.


Friends And Related Function Documentation

bool operator== ( const referredCell a,
const referredCell b 
)
friend

Definition at line 100 of file referredCellI.H.

bool operator!= ( const referredCell a,
const referredCell b 
)
friend

Definition at line 113 of file referredCellI.H.

Istream& operator>> ( Istream is,
referredCell rC 
)
friend

Definition at line 406 of file referredCell.C.

Ostream& operator<< ( Ostream os,
const referredCell rC 
)
friend

Definition at line 425 of file referredCell.C.


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