FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

referredCell Class Reference

#include <molecule/referredCell.H>


Detailed Description

Source files

Definition at line 58 of file referredCell.H.

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 vector &  offset () const
const tensor &  rotation () const
const vectorList &  vertexPositions () const
const edgeList &  edges () const
const labelListList &  faces () const
const vectorList &  faceCentres () const
const vectorList &  faceAreas () const
labelList &  realCells ()
const labelList &  realCellsForInteraction () const

Friends

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

Constructor & Destructor Documentation

referredCell (  )

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:
  • src/lagrangian/molecularDynamics/molecule/interactionLists/referredCell/referredCell.H
  • src/lagrangian/molecularDynamics/molecule/interactionLists/referredCell/referredCell.C
  • src/lagrangian/molecularDynamics/molecule/interactionLists/referredCell/referredCellI.H