domain_schema.hpp File Reference

File containing the DomainSchema class. The idea here is to prevent a class of bugs wherein the user or developer things that their mesh is valid but there is some subtle difference between their mesh and what we expect. DomainSchema lets us define the particular traits a mesh must have to be valid (e.g. must have a particular set of domain and boundary IDs, those must correspond to a particular set of topological relations). Then the first things that happens when a mesh is loaded is that it is validated against this schema. More...

#include <cstddef>
#include "serif/discretization/domain/concepts.hpp"
#include "serif/discretization/domain/ids/lists/concepts.hpp"
#include "serif/discretization/domain/relation/lists/concepts.hpp"
#include "serif/discretization/domain/relation/validation/concepts.hpp"
#include "serif/discretization/domain/resolver.hpp"

Include dependency graph for domain_schema.hpp:

This graph shows which files directly or indirectly include this file:

Classes
struct	serif::discretization::domain::schema::DomainSchema< DomainIDs, BoundaryIDs, Relations >
	A DomainSchema is a collection of relations that describe the relationships between domains and boundaries in a mesh. It is used to validate that a mesh has the expected set of domains and boundaries, and that those domains and boundaries have the expected topological relations. This is important for ensuring that the mesh is suitable for the intended simulation or analysis. There is one primary schema we define for SERiF, that is three domains (core, envelope, and vacuum) and two boundaries (stellar surface and infinity surface). See schemas.hpp for more information on this schema. More...

Namespaces
namespace	serif
namespace	serif::discretization
namespace	serif::discretization::domain
namespace	serif::discretization::domain::schema

Detailed Description

File containing the DomainSchema class. The idea here is to prevent a class of bugs wherein the user or developer things that their mesh is valid but there is some subtle difference between their mesh and what we expect. DomainSchema lets us define the particular traits a mesh must have to be valid (e.g. must have a particular set of domain and boundary IDs, those must correspond to a particular set of topological relations). Then the first things that happens when a mesh is loaded is that it is validated against this schema.

Author

Emily M. Boudreaux

If you wish to extend the set of relations that can be validated or introduce a new more complex kind of mesh that SERiF can use you will likely want to start here or in adjacent files.