Galeri::FiniteElements::QuadRectangleGrid Class Reference

Creates a grid with quadrilaterals on a rectangle. More...

#include <Galeri_QuadRectangleGrid.h>

Inheritance diagram for Galeri::FiniteElements::QuadRectangleGrid:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 QuadRectangleGrid (const Epetra_Comm &Comm, const int nx, const int ny, const int mx, const int my, const double lx=1.0, const double ly=1.0)
 Constructor.
virtual ~QuadRectangleGrid ()
 Destructor.
virtual int NumDimensions () const
 Returns the number of dimensions of the grid.
virtual int NumVerticesPerElement () const
 Returns the number of vertices contained in each element.
virtual int NumFacesPerElement () const
 Returns the number of faces contained in each element.
virtual int NumVerticesPerFace () const
 Returns the number of vertices contained in each face.
virtual string ElementType () const
 Returns GALERI_QUAD.
virtual const Epetra_CommComm () const
 Returns a reference to the communicator object.
virtual int NumMyElements () const
 Returns the number of finite elements on the calling process.
virtual int NumGlobalElements () const
 Returns the global number of finite elements.
virtual int NumMyVertices () const
 Returns the number of vertices on the calling process.
virtual int NumGlobalVertices () const
 Returns the global number of vertices.
virtual int NumMyBoundaryFaces () const
 Returns the number of boundary faces on the calling process.
virtual int NumGlobalBoundaryFaces () const
 Returns the global number of boundary faces.
virtual void VertexCoord (const int LocalID, double *coord) const
 Returns the coordinates of local vertex LocalVertex in vector coord.
virtual void VertexCoord (const int Length, const int *IDs, double *x, double *y, double *z) const
 Returns the coordinates of specified local vertices.
virtual void ElementVertices (const int LocalID, int *elements) const
 Returns the local vertex IDs of the specified local finite element.
virtual double ElementMinLength (const int LocalElement) const
 Returns the volume of the specified local finite element.
virtual double ElementMaxLength (const int LocalElement) const
 Returns the volume of the specified local finite element.
virtual const RefCountPtr
< Epetra_Map
RCPVertexMap () const
virtual const RefCountPtr
< Epetra_Map
RCPElementMap () const
virtual const Epetra_MapVertexMap () const
 Returns a reference to the map representing the vertex distribution.
virtual const Epetra_MapElementMap () const
virtual const Epetra_MapBoundaryFaceMap () const
virtual const Epetra_MapRowMap () const
 Returns a reference to the map representing the distribution of rows.
virtual const Epetra_ImportImporter () const
virtual int ElementTag (const int ID) const
virtual int VertexTag (const int ID) const
virtual double ElementVolume () const
virtual void FaceVertices (const int LocalFace, int &tag, int *IDs) const
 Returns the local vertex IDs of vertices contained in the specified boundary face.
int FacePatch (const int LocalFace) const
 Returns the patch ID of the specified face.
int NumMyElementsX () const
int NumMyElementsY () const
int NumMyVerticesX () const
int NumMyVerticesY () const
int NumGlobalElementsX () const
int NumGlobalElementsY () const
int NumGlobalVerticesX () const
int NumGlobalVerticesY () const
double LengthX () const
double LengthY () const
double DeltaX () const
double DeltaY () const
virtual double ElementVolume (const int LocalElement) const
 Returns the volume of the specified local finite element.
virtual double FaceArea (const int LocalFace) const
 Returns the area of the specified local face.
virtual double MyVolume () const
 Returns the volume of all local elements.
virtual double GlobalVolume () const
 Returns the global volume of the grid.
int NumDomainsX () const
int NumDomainsY () const
void ExportToVertexMap (const Epetra_DistObject &RowObject, Epetra_DistObject &VertexObject) const
 Exports distributed object from RowMap() to VertexMap().
void ExportToRowMap (const Epetra_DistObject &VertexObject, Epetra_DistObject &RowObject) const
 Exports distributed object from VertexMap() to RowMap().
int NumNeighborsPerElement () const
 Returns the number of neighboring elements.
void ElementNeighbors (int, int *) const
 Returns the local IDs of neighboring elements.

Private Member Functions

void IL_ElementVertices (const int LocalID, int *elements, const bool ReturnGlobal=false) const
void CreateRowMap ()
void CreateElementMap ()
void CreateBoundaryFaceMap ()
void CreateVertexMap ()

Private Attributes

const Epetra_CommComm_
int NumMyVertices_
int NumMyVerticesX_
int NumMyVerticesY_
int NumGlobalVertices_
int NumMyElements_
int NumMyElementsX_
int NumMyElementsY_
int NumGlobalElements_
int NumMyBoundaryFaces_
int NumGlobalBoundaryFaces_
int nx_
int ny_
double lx_
double ly_
int mx_
int my_
double deltax_
double deltay_
RefCountPtr< Epetra_MapVertexMap_
RefCountPtr< Epetra_MapElementMap_
RefCountPtr< Epetra_MapBoundaryFaceMap_
RefCountPtr< Epetra_MapRowMap_
RefCountPtr< Epetra_ImportImporter_

Detailed Description

Creates a grid with quadrilaterals on a rectangle.

Author:
Marzio Sala, SNL 9214.
Date:
Last updated on 31-Mar-05.

Definition at line 61 of file Galeri_QuadRectangleGrid.h.


Constructor & Destructor Documentation

Galeri::FiniteElements::QuadRectangleGrid::QuadRectangleGrid ( const Epetra_Comm Comm,
const int  nx,
const int  ny,
const int  mx,
const int  my,
const double  lx = 1.0,
const double  ly = 1.0 
) [inline]

Constructor.

Parameters:
Comm - (In) Communicator object.
nx - (In) number of elements along the X-axis.
ny - (In) number of elements along the Y-axis.
mx - (In) Number of subdomains along the X-axis.
my - (In) Number of subdomains along the Y-axis.
lx - (In) Length of the rectangle along the X-axis.
ly - (In) Length of the rectangle along the Y-axis.
Note:
The total number of processors must equal mx * my.

Definition at line 84 of file Galeri_QuadRectangleGrid.h.

virtual Galeri::FiniteElements::QuadRectangleGrid::~QuadRectangleGrid (  )  [inline, virtual]

Destructor.

Definition at line 126 of file Galeri_QuadRectangleGrid.h.


Member Function Documentation

virtual int Galeri::FiniteElements::QuadRectangleGrid::NumDimensions (  )  const [inline, virtual]

Returns the number of dimensions of the grid.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 128 of file Galeri_QuadRectangleGrid.h.

virtual int Galeri::FiniteElements::QuadRectangleGrid::NumVerticesPerElement (  )  const [inline, virtual]

Returns the number of vertices contained in each element.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 133 of file Galeri_QuadRectangleGrid.h.

virtual int Galeri::FiniteElements::QuadRectangleGrid::NumFacesPerElement (  )  const [inline, virtual]

Returns the number of faces contained in each element.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 138 of file Galeri_QuadRectangleGrid.h.

virtual int Galeri::FiniteElements::QuadRectangleGrid::NumVerticesPerFace (  )  const [inline, virtual]

Returns the number of vertices contained in each face.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 143 of file Galeri_QuadRectangleGrid.h.

virtual string Galeri::FiniteElements::QuadRectangleGrid::ElementType (  )  const [inline, virtual]

Returns GALERI_QUAD.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 149 of file Galeri_QuadRectangleGrid.h.

virtual const Epetra_Comm& Galeri::FiniteElements::QuadRectangleGrid::Comm (  )  const [inline, virtual]

Returns a reference to the communicator object.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 154 of file Galeri_QuadRectangleGrid.h.

virtual int Galeri::FiniteElements::QuadRectangleGrid::NumMyElements (  )  const [inline, virtual]

Returns the number of finite elements on the calling process.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 159 of file Galeri_QuadRectangleGrid.h.

virtual int Galeri::FiniteElements::QuadRectangleGrid::NumGlobalElements (  )  const [inline, virtual]

Returns the global number of finite elements.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 164 of file Galeri_QuadRectangleGrid.h.

virtual int Galeri::FiniteElements::QuadRectangleGrid::NumMyVertices (  )  const [inline, virtual]

Returns the number of vertices on the calling process.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 169 of file Galeri_QuadRectangleGrid.h.

virtual int Galeri::FiniteElements::QuadRectangleGrid::NumGlobalVertices (  )  const [inline, virtual]

Returns the global number of vertices.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 174 of file Galeri_QuadRectangleGrid.h.

virtual int Galeri::FiniteElements::QuadRectangleGrid::NumMyBoundaryFaces (  )  const [inline, virtual]

Returns the number of boundary faces on the calling process.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 179 of file Galeri_QuadRectangleGrid.h.

virtual int Galeri::FiniteElements::QuadRectangleGrid::NumGlobalBoundaryFaces (  )  const [inline, virtual]

Returns the global number of boundary faces.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 184 of file Galeri_QuadRectangleGrid.h.

virtual void Galeri::FiniteElements::QuadRectangleGrid::VertexCoord ( const int  LocalVertex,
double *  coord 
) const [inline, virtual]

Returns the coordinates of local vertex LocalVertex in vector coord.

Parameters:
LocalVertex - (In) Local ID of the vertex for whic coordinates are required. Must be contained in the interval [0, NumMyVertices())
coord - (Out) double array of size 3. In output, contains the x-, y- and z-coordinate of the specified vertex.
Note:
Parameter coord must be allocated of size 3 for both 2D and 3D problems.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 189 of file Galeri_QuadRectangleGrid.h.

virtual void Galeri::FiniteElements::QuadRectangleGrid::VertexCoord ( const int  Length,
const int *  IDs,
double *  x,
double *  y,
double *  z 
) const [inline, virtual]

Returns the coordinates of specified local vertices.

Parameters:
Length - (In) Length of array IDs.
IDs - (In) Contains the list of vertices of which coordinates are required.
x - (Out) double array of size Length. In output, contains the x-coordinates of the specified vertices.
y - (Out) double array of size Length. In output, contains the y-coordinates of the specified vertices.
z - (Out) double array of size Length. In output, contains the z-coordinates of the specified vertices.
Note:
The z array must be allocated for both 2D and 3D problems.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 209 of file Galeri_QuadRectangleGrid.h.

virtual void Galeri::FiniteElements::QuadRectangleGrid::ElementVertices ( const int  LocalElement,
int *  elements 
) const [inline, virtual]

Returns the local vertex IDs of the specified local finite element.

Parameters:
LocalElement - (In) ID of the required local element.
elements - (Out) array of length NumElementVertices(), in output will contain the local ID of the vertices of the specified element.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 227 of file Galeri_QuadRectangleGrid.h.

virtual double Galeri::FiniteElements::QuadRectangleGrid::ElementMinLength ( const int  LocalElement  )  const [inline, virtual]

Returns the volume of the specified local finite element.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 232 of file Galeri_QuadRectangleGrid.h.

virtual double Galeri::FiniteElements::QuadRectangleGrid::ElementMaxLength ( const int  LocalElement  )  const [inline, virtual]

Returns the volume of the specified local finite element.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 240 of file Galeri_QuadRectangleGrid.h.

virtual const RefCountPtr<Epetra_Map> Galeri::FiniteElements::QuadRectangleGrid::RCPVertexMap (  )  const [inline, virtual]

Definition at line 245 of file Galeri_QuadRectangleGrid.h.

virtual const RefCountPtr<Epetra_Map> Galeri::FiniteElements::QuadRectangleGrid::RCPElementMap (  )  const [inline, virtual]

Definition at line 250 of file Galeri_QuadRectangleGrid.h.

virtual const Epetra_Map& Galeri::FiniteElements::QuadRectangleGrid::VertexMap (  )  const [inline, virtual]

Returns a reference to the map representing the vertex distribution.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 255 of file Galeri_QuadRectangleGrid.h.

virtual const Epetra_Map& Galeri::FiniteElements::QuadRectangleGrid::ElementMap (  )  const [inline, virtual]

Definition at line 260 of file Galeri_QuadRectangleGrid.h.

virtual const Epetra_Map& Galeri::FiniteElements::QuadRectangleGrid::BoundaryFaceMap (  )  const [inline, virtual]

Definition at line 265 of file Galeri_QuadRectangleGrid.h.

virtual const Epetra_Map& Galeri::FiniteElements::QuadRectangleGrid::RowMap (  )  const [inline, virtual]

Returns a reference to the map representing the distribution of rows.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 270 of file Galeri_QuadRectangleGrid.h.

virtual const Epetra_Import& Galeri::FiniteElements::QuadRectangleGrid::Importer (  )  const [inline, virtual]

Definition at line 275 of file Galeri_QuadRectangleGrid.h.

virtual int Galeri::FiniteElements::QuadRectangleGrid::ElementTag ( const int  ID  )  const [inline, virtual]

Definition at line 280 of file Galeri_QuadRectangleGrid.h.

virtual int Galeri::FiniteElements::QuadRectangleGrid::VertexTag ( const int  ID  )  const [inline, virtual]

Definition at line 285 of file Galeri_QuadRectangleGrid.h.

virtual double Galeri::FiniteElements::QuadRectangleGrid::ElementVolume (  )  const [inline, virtual]

Definition at line 290 of file Galeri_QuadRectangleGrid.h.

virtual void Galeri::FiniteElements::QuadRectangleGrid::FaceVertices ( const int  LocalFace,
int &  tag,
int *  IDs 
) const [inline, virtual]

Returns the local vertex IDs of vertices contained in the specified boundary face.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 295 of file Galeri_QuadRectangleGrid.h.

int Galeri::FiniteElements::QuadRectangleGrid::FacePatch ( const int  LocalFace  )  const [inline, virtual]

Returns the patch ID of the specified face.

Returns an integer ID that identifies the given boundary face as belonging to a given part of the domain. It can be used by the user to specify the value and the type of the boundary condition.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 340 of file Galeri_QuadRectangleGrid.h.

int Galeri::FiniteElements::QuadRectangleGrid::NumMyElementsX (  )  const [inline]

Definition at line 358 of file Galeri_QuadRectangleGrid.h.

int Galeri::FiniteElements::QuadRectangleGrid::NumMyElementsY (  )  const [inline]

Definition at line 363 of file Galeri_QuadRectangleGrid.h.

int Galeri::FiniteElements::QuadRectangleGrid::NumMyVerticesX (  )  const [inline]

Definition at line 368 of file Galeri_QuadRectangleGrid.h.

int Galeri::FiniteElements::QuadRectangleGrid::NumMyVerticesY (  )  const [inline]

Definition at line 373 of file Galeri_QuadRectangleGrid.h.

int Galeri::FiniteElements::QuadRectangleGrid::NumGlobalElementsX (  )  const [inline]

Definition at line 378 of file Galeri_QuadRectangleGrid.h.

int Galeri::FiniteElements::QuadRectangleGrid::NumGlobalElementsY (  )  const [inline]

Definition at line 383 of file Galeri_QuadRectangleGrid.h.

int Galeri::FiniteElements::QuadRectangleGrid::NumGlobalVerticesX (  )  const [inline]

Definition at line 388 of file Galeri_QuadRectangleGrid.h.

int Galeri::FiniteElements::QuadRectangleGrid::NumGlobalVerticesY (  )  const [inline]

Definition at line 393 of file Galeri_QuadRectangleGrid.h.

double Galeri::FiniteElements::QuadRectangleGrid::LengthX (  )  const [inline]

Definition at line 398 of file Galeri_QuadRectangleGrid.h.

double Galeri::FiniteElements::QuadRectangleGrid::LengthY (  )  const [inline]

Definition at line 403 of file Galeri_QuadRectangleGrid.h.

double Galeri::FiniteElements::QuadRectangleGrid::DeltaX (  )  const [inline]

Definition at line 408 of file Galeri_QuadRectangleGrid.h.

double Galeri::FiniteElements::QuadRectangleGrid::DeltaY (  )  const [inline]

Definition at line 413 of file Galeri_QuadRectangleGrid.h.

virtual double Galeri::FiniteElements::QuadRectangleGrid::ElementVolume ( const int  LocalElement  )  const [inline, virtual]

Returns the volume of the specified local finite element.

Returns the area (in 2D) or the volume (in 3D) of the specified local element

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 418 of file Galeri_QuadRectangleGrid.h.

virtual double Galeri::FiniteElements::QuadRectangleGrid::FaceArea ( const int  LocalFace  )  const [inline, virtual]

Returns the area of the specified local face.

Returns the length (in 2D) or the area (in 3D) of the specified boundary face

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 423 of file Galeri_QuadRectangleGrid.h.

virtual double Galeri::FiniteElements::QuadRectangleGrid::MyVolume (  )  const [inline, virtual]

Returns the volume of all local elements.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 432 of file Galeri_QuadRectangleGrid.h.

virtual double Galeri::FiniteElements::QuadRectangleGrid::GlobalVolume (  )  const [inline, virtual]

Returns the global volume of the grid.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 437 of file Galeri_QuadRectangleGrid.h.

int Galeri::FiniteElements::QuadRectangleGrid::NumDomainsX (  )  const [inline]

Definition at line 442 of file Galeri_QuadRectangleGrid.h.

int Galeri::FiniteElements::QuadRectangleGrid::NumDomainsY (  )  const [inline]

Definition at line 447 of file Galeri_QuadRectangleGrid.h.

void Galeri::FiniteElements::QuadRectangleGrid::ExportToVertexMap ( const Epetra_DistObject RowObject,
Epetra_DistObject VertexObject 
) const [inline, virtual]

Exports distributed object from RowMap() to VertexMap().

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 452 of file Galeri_QuadRectangleGrid.h.

void Galeri::FiniteElements::QuadRectangleGrid::ExportToRowMap ( const Epetra_DistObject RowObject,
Epetra_DistObject VertexObject 
) const [inline, virtual]

Exports distributed object from VertexMap() to RowMap().

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 458 of file Galeri_QuadRectangleGrid.h.

int Galeri::FiniteElements::QuadRectangleGrid::NumNeighborsPerElement (  )  const [inline, virtual]

Returns the number of neighboring elements.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 464 of file Galeri_QuadRectangleGrid.h.

void Galeri::FiniteElements::QuadRectangleGrid::ElementNeighbors ( int  LocalElement,
int *  elements 
) const [inline, virtual]

Returns the local IDs of neighboring elements.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 469 of file Galeri_QuadRectangleGrid.h.

void Galeri::FiniteElements::QuadRectangleGrid::IL_ElementVertices ( const int  LocalID,
int *  elements,
const bool  ReturnGlobal = false 
) const [inline, private]

Definition at line 478 of file Galeri_QuadRectangleGrid.h.

void Galeri::FiniteElements::QuadRectangleGrid::CreateRowMap (  )  [inline, private]

Definition at line 498 of file Galeri_QuadRectangleGrid.h.

void Galeri::FiniteElements::QuadRectangleGrid::CreateElementMap (  )  [inline, private]

Definition at line 534 of file Galeri_QuadRectangleGrid.h.

void Galeri::FiniteElements::QuadRectangleGrid::CreateBoundaryFaceMap (  )  [inline, private]

Definition at line 573 of file Galeri_QuadRectangleGrid.h.

void Galeri::FiniteElements::QuadRectangleGrid::CreateVertexMap (  )  [inline, private]

Definition at line 638 of file Galeri_QuadRectangleGrid.h.


Member Data Documentation

Definition at line 661 of file Galeri_QuadRectangleGrid.h.

Definition at line 663 of file Galeri_QuadRectangleGrid.h.

Definition at line 664 of file Galeri_QuadRectangleGrid.h.

Definition at line 665 of file Galeri_QuadRectangleGrid.h.

Definition at line 666 of file Galeri_QuadRectangleGrid.h.

Definition at line 667 of file Galeri_QuadRectangleGrid.h.

Definition at line 668 of file Galeri_QuadRectangleGrid.h.

Definition at line 669 of file Galeri_QuadRectangleGrid.h.

Definition at line 670 of file Galeri_QuadRectangleGrid.h.

Definition at line 671 of file Galeri_QuadRectangleGrid.h.

Definition at line 672 of file Galeri_QuadRectangleGrid.h.

Definition at line 674 of file Galeri_QuadRectangleGrid.h.

Definition at line 675 of file Galeri_QuadRectangleGrid.h.

Definition at line 676 of file Galeri_QuadRectangleGrid.h.

Definition at line 677 of file Galeri_QuadRectangleGrid.h.

Definition at line 678 of file Galeri_QuadRectangleGrid.h.

Definition at line 679 of file Galeri_QuadRectangleGrid.h.

Definition at line 680 of file Galeri_QuadRectangleGrid.h.

Definition at line 681 of file Galeri_QuadRectangleGrid.h.

Definition at line 683 of file Galeri_QuadRectangleGrid.h.

Definition at line 684 of file Galeri_QuadRectangleGrid.h.

Definition at line 685 of file Galeri_QuadRectangleGrid.h.

Definition at line 686 of file Galeri_QuadRectangleGrid.h.

Definition at line 687 of file Galeri_QuadRectangleGrid.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends Defines
Generated on Wed Apr 13 10:08:41 2011 for Galeri Package Browser (Single Doxygen Collection) by  doxygen 1.6.3