Class documentation of Concepts

Loading...
Searching...
No Matches
parallel::Mesh Class Referenceabstract

#include <mesh_p.hh>

Inheritance diagram for parallel::Mesh:
concepts::OutputOperator parallel::Mesh1 parallel::Mesh2 parallel::Mesh3

Public Member Functions

 Mesh (const Communicator &com)
 
const Communicatorcomm () const
 
virtual uint nglobcell () const =0
 Returns the global number of cells in the mesh.
 
virtual uint nloccell () const =0
 Returns the local number of cells in the mesh.
 
virtual Scan< Cell > * globscan ()=0
 
virtual Scan< Cell > * locscan ()=0
 

Protected Member Functions

virtual std::ostream & info (std::ostream &os) const
 Returns information in an output stream.
 

Detailed Description

An abstract class for a parallel mesh.

This class prescribes the common interface for all classes implementing a parallel mesh. This interface consists of methods to query the number of local and global cells in the mesh and to get a scanner over the local and global mesh.

Definition at line 122 of file mesh_p.hh.

Constructor & Destructor Documentation

◆ Mesh()

parallel::Mesh::Mesh ( const Communicator com)
inline

Definition at line 126 of file mesh_p.hh.

◆ ~Mesh()

virtual parallel::Mesh::~Mesh ( )
inlinevirtual

Definition at line 127 of file mesh_p.hh.

Member Function Documentation

◆ comm()

const Communicator & parallel::Mesh::comm ( ) const
inline

Definition at line 129 of file mesh_p.hh.

◆ globscan()

virtual Scan< Cell > * parallel::Mesh::globscan ( )
pure virtual

Returns a scanner over the global cells of the mesh.

Postcondition
The scanner must be deleted after usage. This has to be done by the user.

Implemented in parallel::Mesh1, parallel::Mesh2, and parallel::Mesh3.

◆ info()

virtual std::ostream & parallel::Mesh::info ( std::ostream &  os) const
protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::OutputOperator.

Reimplemented in parallel::Mesh1, parallel::Mesh2, and parallel::Mesh3.

◆ locscan()

virtual Scan< Cell > * parallel::Mesh::locscan ( )
pure virtual

Returns a scanner over the local cells of the mesh.

Postcondition
The scanner must be deleted after usage. This has to be done by the user.

Implemented in parallel::Mesh1, parallel::Mesh2, and parallel::Mesh3.

◆ nglobcell()

virtual uint parallel::Mesh::nglobcell ( ) const
pure virtual

Returns the global number of cells in the mesh.

Implemented in parallel::Mesh1, parallel::Mesh2, and parallel::Mesh3.

◆ nloccell()

virtual uint parallel::Mesh::nloccell ( ) const
pure virtual

Returns the local number of cells in the mesh.

Implemented in parallel::Mesh1, parallel::Mesh2, and parallel::Mesh3.


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