Struct representing the result of validating a relation in the domain module. It contains information about the validation failure, if any, and optional diagnostics for specific relation types. More...

#include <runtime.hpp>

Classes
struct	ConnectedDiagnostics
	Optional diagnostics for the FullyConnected relation type. It contains information about the element ID, domain element count, and visited element count. More...

struct	DomainBoundaryDiagnostics
	Optional diagnostics for the DomainBoundary relation type. It contains information about the face ID, boundary element ID, expected boundary ID, actual boundary ID, first element ID, second element ID, first domain ID, and second domain ID. More...

struct	InscribedDiagnostics
	Optional diagnostics for the Inscribed relation type. It contains information about the face ID, inner element ID, adjacent element ID, and adjacent domain ID. More...

Public Member Functions
bool	valid () const noexcept
	Check if the validation result is valid (i.e., no validation failure occurred).

	operator bool () const noexcept
	Explicit conversion operator to bool. Returns true if the validation result is valid (i.e., no validation failure occurred), false otherwise.

Public Attributes
RelationValidationFailure	failure {RelationValidationFailure::None}
	The type of validation failure that occurred, if any. Default to None.

std::optional< InscribedDiagnostics >	inscribedDiagnostics = std::nullopt
	Optional diagnostics for the Inscribed relation type, if applicable. If no inscribed failure occurred, this will be std::nullopt.

std::optional< ConnectedDiagnostics >	connectedDiagnostics = std::nullopt
	Optional diagnostics for the FullyConnected relation type, if applicable. If no fully connected failure occurred, this will be std::nullopt.

std::optional< DomainBoundaryDiagnostics >	domainBoundaryDiagnostics = std::nullopt
	Optional diagnostics for the DomainBoundary relation type, if applicable. If no domain boundary failure occurred, this will be std::nullopt.

Detailed Description

Struct representing the result of validating a relation in the domain module. It contains information about the validation failure, if any, and optional diagnostics for specific relation types.

Member Function Documentation

◆ operator bool()

serif::discretization::domain::relation::validation::RelationValidationResult::operator bool ( ) const

inlineexplicitnodiscardnoexcept

Explicit conversion operator to bool. Returns true if the validation result is valid (i.e., no validation failure occurred), false otherwise.

Returns: true if the validation result is valid, false otherwise

◆ valid()

bool serif::discretization::domain::relation::validation::RelationValidationResult::valid ( ) const

inlinenodiscardnoexcept

Check if the validation result is valid (i.e., no validation failure occurred).

Returns: true if the validation result is valid, false otherwise

Member Data Documentation

◆ connectedDiagnostics

std::optional<ConnectedDiagnostics> serif::discretization::domain::relation::validation::RelationValidationResult::connectedDiagnostics = std::nullopt

Optional diagnostics for the FullyConnected relation type, if applicable. If no fully connected failure occurred, this will be std::nullopt.

◆ domainBoundaryDiagnostics

std::optional<DomainBoundaryDiagnostics> serif::discretization::domain::relation::validation::RelationValidationResult::domainBoundaryDiagnostics = std::nullopt

Optional diagnostics for the DomainBoundary relation type, if applicable. If no domain boundary failure occurred, this will be std::nullopt.

◆ failure

RelationValidationFailure serif::discretization::domain::relation::validation::RelationValidationResult::failure {RelationValidationFailure::None}

The type of validation failure that occurred, if any. Default to None.

◆ inscribedDiagnostics

std::optional<InscribedDiagnostics> serif::discretization::domain::relation::validation::RelationValidationResult::inscribedDiagnostics = std::nullopt

Optional diagnostics for the Inscribed relation type, if applicable. If no inscribed failure occurred, this will be std::nullopt.

The documentation for this struct was generated from the following file:

src/include/serif/discretization/domain/relation/validation/runtime.hpp

Classes

Public Member Functions

Public Attributes