Galeri::FiniteElements::FileGrid Class Reference

#include <Galeri_FileGrid.h>

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

List of all members.

Public Member Functions

 FileGrid (const Epetra_Comm &Comm, const string FileName)
 Constructor.
virtual ~FileGrid ()
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 a string containing the element type.
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_MapRowMap () const
 Returns a reference to the map representing the distribution of rows.
virtual const Epetra_ImportImporter () const
virtual int ElementTag (const int LocalID) const
virtual int VertexTag (const int LocalID) 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.
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.
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 Attributes

const Epetra_CommComm_
string FileName_
int NumDimensions_
int NumVerticesPerElement_
int NumVerticesPerFace_
int NumFacesPerElement_
int NumMyVertices_
int NumGlobalVertices_
int NumMyElements_
int NumGlobalElements_
int NumMyBoundaryFaces_
int NumGlobalBoundaryFaces_
string ElementType_
Epetra_SerialDenseMatrix VertexCoord_
Epetra_IntSerialDenseMatrix ElementVertices_
Epetra_IntSerialDenseMatrix FaceVertices_
Epetra_SerialDenseVector ElementMaxLength_
Epetra_SerialDenseVector ElementMinLength_
Epetra_SerialDenseVector ElementVolume_
RefCountPtr< Epetra_MapVertexMap_
RefCountPtr< Epetra_MapElementMap_
RefCountPtr< Epetra_MapRowMap_
RefCountPtr< Epetra_ImportImporter_

Detailed Description

Definition at line 64 of file Galeri_FileGrid.h.


Constructor & Destructor Documentation

Galeri::FiniteElements::FileGrid::FileGrid ( const Epetra_Comm Comm,
const string  FileName 
) [inline]

Constructor.

Parameters:
Comm - (In) Communicator object.
FileName - (In) Name of grid file.

Definition at line 75 of file Galeri_FileGrid.h.

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

Definition at line 325 of file Galeri_FileGrid.h.


Member Function Documentation

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

Returns the number of dimensions of the grid.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 327 of file Galeri_FileGrid.h.

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

Returns the number of vertices contained in each element.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 332 of file Galeri_FileGrid.h.

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

Returns the number of faces contained in each element.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 337 of file Galeri_FileGrid.h.

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

Returns the number of vertices contained in each face.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 342 of file Galeri_FileGrid.h.

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

Returns a string containing the element type.

Returns a string containing the type of element. This string is used in the quadrature class. Currently supported options are:

  • "GALERI_TRIANGLE"
  • "GALERI_QUAD"
  • "GALERI_HEX"
  • "GALERI_TET"

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 347 of file Galeri_FileGrid.h.

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

Returns a reference to the communicator object.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 352 of file Galeri_FileGrid.h.

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

Returns the number of finite elements on the calling process.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 357 of file Galeri_FileGrid.h.

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

Returns the global number of finite elements.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 362 of file Galeri_FileGrid.h.

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

Returns the number of vertices on the calling process.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 367 of file Galeri_FileGrid.h.

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

Returns the global number of vertices.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 372 of file Galeri_FileGrid.h.

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

Returns the number of boundary faces on the calling process.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 377 of file Galeri_FileGrid.h.

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

Returns the global number of boundary faces.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 382 of file Galeri_FileGrid.h.

virtual void Galeri::FiniteElements::FileGrid::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 387 of file Galeri_FileGrid.h.

virtual void Galeri::FiniteElements::FileGrid::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 400 of file Galeri_FileGrid.h.

virtual void Galeri::FiniteElements::FileGrid::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 419 of file Galeri_FileGrid.h.

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

Returns the volume of the specified local finite element.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 425 of file Galeri_FileGrid.h.

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

Returns the volume of the specified local finite element.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 430 of file Galeri_FileGrid.h.

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

Definition at line 435 of file Galeri_FileGrid.h.

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

Definition at line 440 of file Galeri_FileGrid.h.

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

Returns a reference to the map representing the vertex distribution.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 445 of file Galeri_FileGrid.h.

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

Definition at line 450 of file Galeri_FileGrid.h.

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

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

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 455 of file Galeri_FileGrid.h.

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

Definition at line 460 of file Galeri_FileGrid.h.

virtual int Galeri::FiniteElements::FileGrid::ElementTag ( const int  LocalID  )  const [inline, virtual]

Definition at line 465 of file Galeri_FileGrid.h.

virtual int Galeri::FiniteElements::FileGrid::VertexTag ( const int  LocalID  )  const [inline, virtual]

Definition at line 470 of file Galeri_FileGrid.h.

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

Definition at line 475 of file Galeri_FileGrid.h.

virtual void Galeri::FiniteElements::FileGrid::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 480 of file Galeri_FileGrid.h.

int Galeri::FiniteElements::FileGrid::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 487 of file Galeri_FileGrid.h.

virtual double Galeri::FiniteElements::FileGrid::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 492 of file Galeri_FileGrid.h.

virtual double Galeri::FiniteElements::FileGrid::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 497 of file Galeri_FileGrid.h.

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

Returns the volume of all local elements.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 502 of file Galeri_FileGrid.h.

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

Returns the global volume of the grid.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 507 of file Galeri_FileGrid.h.

void Galeri::FiniteElements::FileGrid::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 512 of file Galeri_FileGrid.h.

void Galeri::FiniteElements::FileGrid::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 518 of file Galeri_FileGrid.h.

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

Returns the number of neighboring elements.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 524 of file Galeri_FileGrid.h.

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

Returns the local IDs of neighboring elements.

Implements Galeri::FiniteElements::AbstractGrid.

Definition at line 529 of file Galeri_FileGrid.h.


Member Data Documentation

Definition at line 535 of file Galeri_FileGrid.h.

Definition at line 536 of file Galeri_FileGrid.h.

Definition at line 538 of file Galeri_FileGrid.h.

Definition at line 539 of file Galeri_FileGrid.h.

Definition at line 540 of file Galeri_FileGrid.h.

Definition at line 541 of file Galeri_FileGrid.h.

Definition at line 543 of file Galeri_FileGrid.h.

Definition at line 544 of file Galeri_FileGrid.h.

Definition at line 546 of file Galeri_FileGrid.h.

Definition at line 547 of file Galeri_FileGrid.h.

Definition at line 549 of file Galeri_FileGrid.h.

Definition at line 550 of file Galeri_FileGrid.h.

Definition at line 552 of file Galeri_FileGrid.h.

Definition at line 554 of file Galeri_FileGrid.h.

Definition at line 555 of file Galeri_FileGrid.h.

Definition at line 556 of file Galeri_FileGrid.h.

Definition at line 557 of file Galeri_FileGrid.h.

Definition at line 558 of file Galeri_FileGrid.h.

Definition at line 559 of file Galeri_FileGrid.h.

Definition at line 561 of file Galeri_FileGrid.h.

Definition at line 562 of file Galeri_FileGrid.h.

Definition at line 563 of file Galeri_FileGrid.h.

Definition at line 564 of file Galeri_FileGrid.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