class PolyGeom

Polygon Geometry functions

Inheritance:

public members:

Constructors, destructors

PolyGeom()

~PolyGeom()

Utility functions

Tuple <REAL, BL_SPACEDIM > getIrregFaceCentroid( VoF n)

Tuple <REAL, BL_SPACEDIM > getCentroid( VoF n)

REAL getLinearConst( VoF n)

Tuple <REAL, BL_SPACEDIM > getCentroidXArea( VoF n)

Tuple <REAL, BL_SPACEDIM > getNormal( VoF n)

Tuple <REAL, BL_SPACEDIM > getFaceCentroid( Face e)

Vector < Tuple <REAL, BL_SPACEDIM > > polygon( VoF n)

Vector < Tuple <REAL, BL_SPACEDIM > > polygon3D( VoF n)

Vector < Tuple <REAL, BL_SPACEDIM > > boundaryPolygon( VoF n)

Vector < Tuple <REAL, BL_SPACEDIM > > polygon2D(Real nx, Real ny, Real c)

Modification functions

void setTolerance(REAL tolin)

Access functions

REAL getTolerance() const

Tuple <Real,3> cross(const Tuple <Real,3>& x1, const Tuple <Real,3>& x2) const

PolyGeom ()

Default constructor.

~PolyGeom ()

Default destructor.

Tuple <REAL, BL_SPACEDIM > getIrregFaceCentroid ( VoF n)

Finds the centroid of the irregular face of a 2D vof. Arguments: n (not modified) is the input 2D vof. Returns: This returns the coordinates of the centroid of the irregular face. The coordinates have values between -0.5 and 0.5, inclusive. The origin is at the center of the grid cell, and the grid cell is assumed to be of unit length in all directions. Dependencies: getNormal and getFaceCentroid must be called before this function. This: This object is not modified.

Tuple <REAL, BL_SPACEDIM > getCentroid ( VoF n)

Finds the centroid of a vof. Arguments: n (not modified) is the input vof. Returns: This returns the coordinates of the centroid. The coordinates have values between -0.5 and 0.5, inclusive. The origin is at the center of the grid cell, and the grid cell is assumed to be of unit length in all directions. Dependencies: getNormal and getFaceCentroid must be called before this function. This: This object is not modified.

REAL getLinearConst ( VoF n)

In 2D (3D) finds d where ax + by (+cz) = d. Arguments: n (not modified) is an Irregular vof. Returns: For an Irregular vof in 2D (3D), returns d where ax + by (+cz) = d, where (a,b) ((a,b,c)) is normal to the boundary. The grid cell is in a coordinate system with the origin at the center of the cell, and the grid cell is assumed to be of unit length in all directions. Dependencies: getNormal must be called before this is called. This: This object is not modified.

Tuple <REAL, BL_SPACEDIM > getCentroidXArea ( VoF n)

Calculates area * centroid of the boundary face of vof n. Arguments: n (not modified) is an Irregular vof. Returns: This returns the coordinates of the centroid of the boundary face of vof n, scaled by it's area. The grid cell is in a coordinate system with the origin at the center of the cell, and the grid cell is assumed to be of unit length in all directions. Dependencies: getNormal must be called before this function. This: This object is not modified.

Tuple <REAL, BL_SPACEDIM > getNormal ( VoF n)

Returns the normal to the boundary in vof n. Arguments: n (not modified) is a vof. Returns: This returns the normal to the boundary line or plane in vof n. If n is not irregular, then it returns the zero vector. This: This object is not modified.

Tuple <REAL, BL_SPACEDIM > getFaceCentroid ( Face e)

Calculates centroid of an face e. Arguments: e (not modified) is the input face. Returns: This returns the coordinates of the centroid. The grid cell is in a coordinate system with the origin at the center of the cell, and the grid cell is assumed to be of unit length in all directions. Dependencies: getNormal must be called before this function. This: This object is not modified.

Vector < Tuple <REAL, BL_SPACEDIM > > polygon ( VoF n)

In 2D, calculates the points describing the polygon formed by vof n. Arguments: n (not modified) is an Irregular vof. Returns: A Vector of coordinates of the points describing the polygon formed by n. The grid cell is in a coordinate system with the origin at the center of the cell, and the grid cell is assumed to be of unit length in all directions. If the embedded body is smaller than the grid cell, then polygon will return a small square within a larger square connected by a line. The area between these two squares will be equal to the vof's volume fraction. Dependencies: getNormal must be called before this function. This: This object is not modified.

Vector < Tuple <REAL, BL_SPACEDIM > > polygon3D ( VoF n)

In 3D, calculates the points describing the polygon formed by vof n. Arguments: n (not modified) is an Irregular vof. Returns: A Vector of coordinates of the points describing the polygon formed by n. The grid cell is in a coordinate system with the origin at the center of the cell, and the grid cell is assumed to be of unit length in all directions. Dependencies: getNormal must be called before this function. This: This object is not modified.

Vector < Tuple <REAL, BL_SPACEDIM > > boundaryPolygon ( VoF n)

In 3D, calculates the points describing the polygon on the boundary of the computational domain. Arguments: n (not modified) is an Irregular vof. Returns: If an face of vof n is a boundary face, then it returns the polygon formed on that face. Dependencies: getNormal must be called before this function. This: This object is not modified.

Vector < Tuple <REAL, BL_SPACEDIM > > polygon2D (Real nx, Real ny, Real c)

Calculates the points describing the polygon when the line nx*x + ny*y = c intersects a square. Arguments: nx (not modified) is the x component of the line's normal. ny (not modified) is the y component of the line's normal. c (not modified) is the constant in nx*x + ny*y = c. Returns: A Vector of coordinates of the points describing the polygon. This: This object is not modified.

void setTolerance (REAL tolin)

Sets the tolerance used to check for zero. Arguments: tolin (not modified) is the value of the new tolerance. Returns: none. This: This object is modified.

REAL getTolerance () const

Gets the tolerance used to check for zero. Arguments: none. Returns: The current tolerance value. This: This object is not modified.

Tuple <Real,3> cross (const Tuple <Real,3>& x1, const Tuple <Real,3>& x2) const

cross product. returns x1 x x2

this class has no child classes.

this page has been generated automatically by doc++