Function t8_cmesh_new_hypercube

Function Documentation

t8_cmesh_t t8_cmesh_new_hypercube(t8_eclass_t eclass, sc_MPI_Comm comm, int do_bcast, int do_partition, int periodic)

Construct a hypercube forest from one primitive tree class.

Parameters:
  • eclass[in] This element class determines the dimension and the number of trees needed to construct a cube.

  • comm[in] The mpi communicator to be used.

  • do_bcast[in] If this flag is nonzero the cmesh is only constructed on processor 0 and then broadcasted to the other processors in comm. TODO: this parameter will be moved to internal.

  • do_partition[in] Create a partitioned cmesh.

  • periodic[in] If true, the coarse mesh will be periodic in each direction. Not possible with eclass pyramid.