Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::CartesianGridDimension Class Reference

Information about the dimensions of a Cartesian grid. More...

#include <arcane/core/CartesianGridDimension.h>

Public Member Functions

 CartesianGridDimension (Int64 nb_cell_x, Int64 nb_cell_y)
 Constructs a 2D grid of dimension (nb_cell_x,nb_cell_y).
 CartesianGridDimension (Int64 nb_cell_x, Int64 nb_cell_y, Int64 nb_cell_z)
 Constructs a 3D grid of dimension (nb_cell_x,nb_cell_y,nb_cell_z).
 CartesianGridDimension (const Int64x2 &dims)
 Constructs a 2D grid of dimension dims.
 CartesianGridDimension (const Int64x3 &dims)
 Constructs a 3D grid of dimension dims.
 CartesianGridDimension (const Int32x2 &dims)
 Constructs a 2D grid of dimension dims.
 CartesianGridDimension (const Int32x3 &dims)
 Constructs a 3D grid of dimension dims.
constexpr Int64x3 nbCell () const
 Number of cells in each direction.
constexpr Int64x3 nbNode () const
 Number of nodes in each direction.
constexpr Int64x3 nbFace () const
 Number of faces in each direction.
constexpr Int64x3 nbFaceParallelToDirection () const
 Total number of faces parallel to a given direction.
constexpr Int64 totalNbCell () const
 Total number of cells.

Friends

class CartesianMeshUniqueIdRenumbering
class CartesianMeshCoarsening
class CartesianMeshCoarsening2

Detailed Description

Information about the dimensions of a Cartesian grid.

This class allows obtaining, based on the number of cells in each direction, the various information about the dimensions of the mesh.

Definition at line 48 of file CartesianGridDimension.h.

Constructor & Destructor Documentation

◆ CartesianGridDimension() [1/6]

Arcane::CartesianGridDimension::CartesianGridDimension ( Int64 nb_cell_x,
Int64 nb_cell_y )

Constructs a 2D grid of dimension (nb_cell_x,nb_cell_y).

Definition at line 40 of file CartesianGridDimension.cc.

◆ CartesianGridDimension() [2/6]

Arcane::CartesianGridDimension::CartesianGridDimension ( Int64 nb_cell_x,
Int64 nb_cell_y,
Int64 nb_cell_z )

Constructs a 3D grid of dimension (nb_cell_x,nb_cell_y,nb_cell_z).

Definition at line 30 of file CartesianGridDimension.cc.

◆ CartesianGridDimension() [3/6]

Arcane::CartesianGridDimension::CartesianGridDimension ( const Int64x2 & dims)
explicit

Constructs a 2D grid of dimension dims.

Definition at line 49 of file CartesianGridDimension.cc.

◆ CartesianGridDimension() [4/6]

Arcane::CartesianGridDimension::CartesianGridDimension ( const Int64x3 & dims)
explicit

Constructs a 3D grid of dimension dims.

Definition at line 58 of file CartesianGridDimension.cc.

◆ CartesianGridDimension() [5/6]

Arcane::CartesianGridDimension::CartesianGridDimension ( const Int32x2 & dims)
explicit

Constructs a 2D grid of dimension dims.

Definition at line 67 of file CartesianGridDimension.cc.

◆ CartesianGridDimension() [6/6]

Arcane::CartesianGridDimension::CartesianGridDimension ( const Int32x3 & dims)
explicit

Constructs a 3D grid of dimension dims.

Definition at line 76 of file CartesianGridDimension.cc.

Member Function Documentation

◆ nbCell()

Int64x3 Arcane::CartesianGridDimension::nbCell ( ) const
inlineconstexpr

Number of cells in each direction.

Definition at line 322 of file CartesianGridDimension.h.

◆ nbFace()

Int64x3 Arcane::CartesianGridDimension::nbFace ( ) const
inlineconstexpr

Number of faces in each direction.

Definition at line 328 of file CartesianGridDimension.h.

◆ nbFaceParallelToDirection()

Int64x3 Arcane::CartesianGridDimension::nbFaceParallelToDirection ( ) const
inlineconstexpr

Total number of faces parallel to a given direction.

Definition at line 331 of file CartesianGridDimension.h.

◆ nbNode()

Int64x3 Arcane::CartesianGridDimension::nbNode ( ) const
inlineconstexpr

Number of nodes in each direction.

Definition at line 325 of file CartesianGridDimension.h.

◆ totalNbCell()

Int64 Arcane::CartesianGridDimension::totalNbCell ( ) const
inlineconstexpr

Total number of cells.

Definition at line 334 of file CartesianGridDimension.h.

◆ CartesianMeshCoarsening

friend class CartesianMeshCoarsening
friend

Definition at line 54 of file CartesianGridDimension.h.

◆ CartesianMeshCoarsening2

friend class CartesianMeshCoarsening2
friend

Definition at line 55 of file CartesianGridDimension.h.

◆ CartesianMeshUniqueIdRenumbering

friend class CartesianMeshUniqueIdRenumbering
friend

Definition at line 53 of file CartesianGridDimension.h.

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