ablate::domain::Domain

ablate::domain::BoxMesh

Create a simple box mesh (1,2,3) dimension When used with the dm_plex_separate_marker each boundary “marker” or “Face Sets” as:

1D

Direction Description Value
x- left 1
x+ right 2

2D:

Direction Description Value
y+ top 3
y- bottom 1
x+ right 2
x- left 4

3D:

Direction Description Value
z- bottom 1
z+ top 2
y+ front 3
y- back 4
x+ right 5
x- left 6
name (req)
(string) the name of the domain/mesh object
fields
(ablate::domain::FieldDescriptor list) a list of fields/field descriptors
modifiers
(ablate::domain::modifiers::Modifier list) a list of domain modifier
faces (req)
(int list) the number of faces in each direction
lower (req)
(double list) the lower bound of the mesh
upper (req)
(double list) the upper bound of the mesh
boundary
(string list) custom boundary types (NONE, GHOSTED, MIRROR, PERIODIC)
simplex
(bool) sets if the elements/cells are simplex
options
(ablate::parameters::Parameters) PETSc options specific to this dm. Default value allows the dm to access global options.

ablate::domain::DMPlex

DMPlex that can be set using PETSc options

fields
(ablate::domain::FieldDescriptor list) a list of fields/field descriptors
name (req)
(string) the mesh dm name
modifiers
(ablate::domain::modifiers::Modifier list) a list of domain modifier
options
(ablate::parameters::Parameters) PETSc options specific to this dm. Default value allows the dm to access global options.

ablate::domain::MeshFile

read a DMPlex from a file

name
(string) the name of the domain/mesh object
path (req)
(file path or url) the path to the mesh file
fields
(ablate::domain::FieldDescriptor list) a list of fields/field descriptors
modifiers
(ablate::domain::modifiers::Modifier list) a list of domain modifier
options
(ablate::parameters::Parameters) PETSc options specific to this dm. Default value allows the dm to access global options.

ablate::domain::BoxMeshBoundaryCells

simple uniform box mesh with boundary solver cells. Available labels are: interiorCells, domain (interior and boundary cells), boundaryFaces, boundaryCells, boundaryCellsLeft, boundaryCellsRight, boundaryCellsBottom, boundaryCellsTop, boundaryCellsFront, and boundaryCellsBack

name (req)
(string) the name of the domain/mesh object
fields
(ablate::domain::FieldDescriptor list) a list of fields/field descriptors
preModifiers
(ablate::domain::modifiers::Modifier list) a list of domain modifiers to apply before ghost labeling
postModifiers
(ablate::domain::modifiers::Modifier list) a list of domain modifiers to apply after ghost labeling
faces (req)
(int list) the number of faces in each direction
lower (req)
(double list) the lower bound of the mesh
upper (req)
(double list) the upper bound of the mesh
options
(ablate::parameters::Parameters) PETSc options specific to this dm. Default value allows the dm to access global options.

ablate::domain::CadFile

read a cad from a file

name (req)
(string) the name of the domain/mesh object
path (req)
(file path or url) the path to the cad file
fields
(ablate::domain::FieldDescriptor list) a list of fields/field descriptors
generator
(string) the mesh generation package name (default is ‘tetgen’)
modifiers
(ablate::domain::modifiers::Modifier list) a list of domain modifier
options
(ablate::parameters::Parameters) PETSc options specific to this dm. Default value allows the dm to access global options.
surfaceOptions
(ablate::parameters::Parameters) PETSc options specific to the temporary surface dm. Default value allows the dm to access global options.

ablate::domain::MeshGenerator

The MeshGenerator will use a mesh description to generate an arbitrary mesh based upon supplied cells/nodes from the description.

name (req)
(string) the name of the domain/mesh object
fields
(ablate::domain::FieldDescriptor list) a list of fields/field descriptors
description (req)
(ablate::domain::descriptions::MeshDescription) the mesh description used to describe the cell/nodes used to create the new mesh
modifiers
(ablate::domain::modifiers::Modifier list) a list of domain modifier
options
(ablate::parameters::Parameters) PETSc options specific to this dm. Default value allows the dm to access global options.