PRISMS-PF Manual
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
RectangularMesh< dim > Struct Template Reference

Class for rectangular mesh parameters. More...

#include <spatial_discretization.h>

Public Member Functions

 RectangularMesh ()=default
 Constructor.
 
 RectangularMesh (dealii::Tensor< 1, dim, double > _size, dealii::Tensor< 1, dim, double > _lower_bound, std::array< unsigned int, dim > _subdivisions)
 Constructor.
 
void generate_mesh (Triangulation< dim > &triangulation) const
 Generate the mesh.
 
void validate () const
 Validate.
 
void mark_boundaries (Triangulation< dim > &triangulation) const
 Mark the boundaries of the mesh.
 
void mark_periodic (Triangulation< dim > &triangulation) const
 Mark the periodic faces of the mesh.
 
template<typename MeshType >
void collect_periodic_faces (const MeshType &triangulation, std::vector< dealii::GridTools::PeriodicFacePair< typename MeshType::cell_iterator > > &periodicity_vector) const
 Get the periodic face pairs.
 

Public Attributes

dealii::Tensor< 1, dim, double > size
 Domain extents in each cartesian direction.
 
dealii::Tensor< 1, dim, double > lower_bound
 Domain extents in each cartesian direction.
 
std::vector< unsigned int > subdivisions = std::vector<unsigned int>(dim, 1)
 Mesh subdivisions in each cartesian direction.
 
std::set< unsigned int > periodic_directions
 Which directions have periodic conditions.
 

Detailed Description

template<unsigned int dim>
struct RectangularMesh< dim >

Class for rectangular mesh parameters.

Constructor & Destructor Documentation

◆ RectangularMesh() [1/2]

template<unsigned int dim>
RectangularMesh< dim >::RectangularMesh ( )
default

Constructor.

◆ RectangularMesh() [2/2]

template<unsigned int dim>
RectangularMesh< dim >::RectangularMesh ( dealii::Tensor< 1, dim, double >  _size,
dealii::Tensor< 1, dim, double >  _lower_bound,
std::array< unsigned int, dim >  _subdivisions 
)
inline

Constructor.

Member Function Documentation

◆ collect_periodic_faces()

template<unsigned int dim>
template<typename MeshType >
void RectangularMesh< dim >::collect_periodic_faces ( const MeshType &  triangulation,
std::vector< dealii::GridTools::PeriodicFacePair< typename MeshType::cell_iterator > > &  periodicity_vector 
) const
inline

Get the periodic face pairs.

◆ generate_mesh()

template<unsigned int dim>
void RectangularMesh< dim >::generate_mesh ( Triangulation< dim > &  triangulation) const
inline

Generate the mesh.

◆ mark_boundaries()

template<unsigned int dim>
void RectangularMesh< dim >::mark_boundaries ( Triangulation< dim > &  triangulation) const
inline

Mark the boundaries of the mesh.

◆ mark_periodic()

template<unsigned int dim>
void RectangularMesh< dim >::mark_periodic ( Triangulation< dim > &  triangulation) const
inline

Mark the periodic faces of the mesh.

◆ validate()

template<unsigned int dim>
void RectangularMesh< dim >::validate ( ) const
inline

Validate.

Member Data Documentation

◆ lower_bound

template<unsigned int dim>
dealii::Tensor<1, dim, double> RectangularMesh< dim >::lower_bound

Domain extents in each cartesian direction.

◆ periodic_directions

template<unsigned int dim>
std::set<unsigned int> RectangularMesh< dim >::periodic_directions

Which directions have periodic conditions.

◆ size

template<unsigned int dim>
dealii::Tensor<1, dim, double> RectangularMesh< dim >::size

Domain extents in each cartesian direction.

◆ subdivisions

template<unsigned int dim>
std::vector<unsigned int> RectangularMesh< dim >::subdivisions = std::vector<unsigned int>(dim, 1)

Mesh subdivisions in each cartesian direction.

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