SERiF v0.0.1a
Stellar Evolution and Rotation in Four Dimensions
Loading...
Searching...
No Matches
serif::geometry::deformation::SurfaceDeformationDescriptor Struct Referencefinal

#include <descriptors.hpp>

Collaboration diagram for serif::geometry::deformation::SurfaceDeformationDescriptor:
[legend]

Public Member Functions

constexpr bool is_valid () const noexcept
 
constexpr bool supports_exact_newton_linearization () const noexcept
 
constexpr bool operator== (const SurfaceDeformationDescriptor &) const =default
 

Public Attributes

std::string_view name
 
int spatialDimension
 
SurfaceMotionKind motionKind
 
bool linearOnReferenceGeometry
 
bool requiresStarShapedReferenceSurface
 
bool hasExactDerivativeTranspose
 
bool hasExactPullbackDerivative
 
GeometricGaugeTreatment translationTreatment
 
GeometricGaugeTreatment orientationTreatment
 

Member Function Documentation

◆ is_valid()

bool serif::geometry::deformation::SurfaceDeformationDescriptor::is_valid ( ) const
inlinenodiscardconstexprnoexcept

◆ operator==()

bool serif::geometry::deformation::SurfaceDeformationDescriptor::operator== ( const SurfaceDeformationDescriptor & ) const
constexprdefault

◆ supports_exact_newton_linearization()

bool serif::geometry::deformation::SurfaceDeformationDescriptor::supports_exact_newton_linearization ( ) const
inlinenodiscardconstexprnoexcept

Member Data Documentation

◆ hasExactDerivativeTranspose

bool serif::geometry::deformation::SurfaceDeformationDescriptor::hasExactDerivativeTranspose

◆ hasExactPullbackDerivative

bool serif::geometry::deformation::SurfaceDeformationDescriptor::hasExactPullbackDerivative

◆ linearOnReferenceGeometry

bool serif::geometry::deformation::SurfaceDeformationDescriptor::linearOnReferenceGeometry

◆ motionKind

SurfaceMotionKind serif::geometry::deformation::SurfaceDeformationDescriptor::motionKind

◆ name

std::string_view serif::geometry::deformation::SurfaceDeformationDescriptor::name

◆ orientationTreatment

GeometricGaugeTreatment serif::geometry::deformation::SurfaceDeformationDescriptor::orientationTreatment

◆ requiresStarShapedReferenceSurface

bool serif::geometry::deformation::SurfaceDeformationDescriptor::requiresStarShapedReferenceSurface

◆ spatialDimension

int serif::geometry::deformation::SurfaceDeformationDescriptor::spatialDimension

◆ translationTreatment

GeometricGaugeTreatment serif::geometry::deformation::SurfaceDeformationDescriptor::translationTreatment

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