Function t8_cmesh_new_brick_3d

Function Documentation

t8_cmesh_t t8_cmesh_new_brick_3d(t8_gloidx_t num_x, t8_gloidx_t num_y, t8_gloidx_t num_z, int x_periodic, int y_periodic, int z_periodic, sc_MPI_Comm comm)

Create a cmesh of hexs whose trees are given by a num_x * num_y * num_z brick connectivity.

Parameters:
  • num_x[in] The number of trees in x-direction. Must be >= 0.

  • num_y[in] The number of trees in y-direction. Must be >= 0.

  • num_z[in] The number of trees in z-direction. Must be >= 0.

  • x_periodic[in] If nonzero, the local brick connectivity is periodic in x direction.

  • y_periodic[in] If nonzero, the local brick connectivity is periodic in y direction.

  • z_periodic[in] If nonzero, the local brick connectivity is periodic in z direction.

  • comm[in] The MPI communicator used to commit the cmesh.

Returns:

A committed and partitioned cmesh.