Template Function t8_mesh_handle::handle_hypercube_uniform_default

• Defined in File constructor_wrappers.hxx

Function Documentation

template<T8MeshType TMeshClass>
std::unique_ptr<TMeshClass> t8_mesh_handle::handle_hypercube_uniform_default(t8_eclass_t eclass, const int level, const sc_MPI_Comm comm, const bool do_partition = false, const bool do_face_ghost = false, const bool periodic = false)

Construct hybercube from one primitive tree class.

Refined uniformly to given level using the default scheme.

Parameters:

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

• level – [in] An initial uniform refinement level.

• comm – [in] MPI communicator to use.

• do_partition – [in] If non-zero create a partitioned cmesh.

• do_face_ghost – [in] If true, a layer of ghost elements is created.

• periodic – [in] If non-zero create a periodic cmesh in each direction. Not possible with eclass pyramid.

Template Parameters:

TMeshClass – The mesh handle class.

Returns:

Unique pointer to a uniformly refined mesh handle hypercube.