120 lines
4.8 KiB
Groff
120 lines
4.8 KiB
Groff
|
.TH "serif::mapping::compactification::ExteriorDomainMap" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::mapping::compactification::ExteriorDomainMap \- Abstract interface for some mapping from reference coordinates to physical coordinates in the exterior domain\&. Currently the only concrete implementation of this is the kelvin compactification\&.
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.PP
|
||
|
|
\fR#include <compactification\&.hpp>\fP
|
||
|
|
.PP
|
||
|
|
Inherited by \fBserif::mapping::compactification::KelvinCompactification\fP\&.
|
||
|
|
.SS "Public Member Functions"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "virtual \fB~ExteriorDomainMap\fP ()=default"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "virtual bool \fBis_affine_in_displacement\fP () const noexcept=0"
|
||
|
|
.br
|
||
|
|
.RI "Check if the mapping is affine in the displacement, that is if the mapping is linear in the displacement and does not depend on the displacement\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "virtual \fBMappingStatus\fP \fBevaluate\fP (const \fBExteriorMapInput\fP &input, \fBExteriorMapResult\fP &result) const =0"
|
||
|
|
.br
|
||
|
|
.RI "Evaluate the mapping at a given point in the reference domain\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "virtual \fBMappingStatus\fP \fBevaluate_variation\fP (const \fBExteriorMapInput\fP &input, const \fBExteriorMapResult\fP &result, const \fBExteriorMapDirection\fP &direction, \fBExteriorMapVariation\fP &variation) const =0"
|
||
|
|
.br
|
||
|
|
.RI "Evaluate the variation of the mapping at a given point in the reference domain\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "virtual std::string_view \fBget_name\fP () const noexcept=0"
|
||
|
|
.br
|
||
|
|
.RI "Return the name of the mapping, which is used for debugging and logging\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
Abstract interface for some mapping from reference coordinates to physical coordinates in the exterior domain\&. Currently the only concrete implementation of this is the kelvin compactification\&.
|
||
|
|
.SH "Constructor & Destructor Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "virtual serif::mapping::compactification::ExteriorDomainMap::~ExteriorDomainMap ()\fR [virtual]\fP, \fR [default]\fP"
|
||
|
|
|
||
|
|
.SH "Member Function Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "virtual \fBMappingStatus\fP serif::mapping::compactification::ExteriorDomainMap::evaluate (const \fBExteriorMapInput\fP & input, \fBExteriorMapResult\fP & result) const\fR [nodiscard]\fP, \fR [pure virtual]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Evaluate the mapping at a given point in the reference domain\&.
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fIinput\fP The input to the mapping, which contains the reference coordinates and the displacement\&.
|
||
|
|
.br
|
||
|
|
\fIresult\fP The result of the mapping, which contains the physical coordinates and the Jacobian of the mapping\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBReturns\fP
|
||
|
|
.RS 4
|
||
|
|
The status of the mapping evaluation, which indicates if the evaluation was successful or if there was an error\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Implemented in \fBserif::mapping::compactification::KelvinCompactification\fP\&.
|
||
|
|
.SS "virtual \fBMappingStatus\fP serif::mapping::compactification::ExteriorDomainMap::evaluate_variation (const \fBExteriorMapInput\fP & input, const \fBExteriorMapResult\fP & result, const \fBExteriorMapDirection\fP & direction, \fBExteriorMapVariation\fP & variation) const\fR [nodiscard]\fP, \fR [pure virtual]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Evaluate the variation of the mapping at a given point in the reference domain\&.
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fIinput\fP The input to the mapping, which contains the reference coordinates and the displacement\&.
|
||
|
|
.br
|
||
|
|
\fIresult\fP The result of the mapping, which contains the physical coordinates and the Jacobian of the mapping\&.
|
||
|
|
.br
|
||
|
|
\fIdirection\fP The direction of the variation, which is a vector in the reference domain\&.
|
||
|
|
.br
|
||
|
|
\fIvariation\fP The variation of the mapping, which contains the variation of the physical coordinates and the variation of the Jacobian\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBReturns\fP
|
||
|
|
.RS 4
|
||
|
|
The status of the mapping evaluation, which indicates if the evaluation was successful or if there was an error\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Implemented in \fBserif::mapping::compactification::KelvinCompactification\fP\&.
|
||
|
|
.SS "virtual std::string_view serif::mapping::compactification::ExteriorDomainMap::get_name () const\fR [nodiscard]\fP, \fR [pure virtual]\fP, \fR [noexcept]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Return the name of the mapping, which is used for debugging and logging\&.
|
||
|
|
.PP
|
||
|
|
\fBReturns\fP
|
||
|
|
.RS 4
|
||
|
|
The name of the mapping\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Implemented in \fBserif::mapping::compactification::KelvinCompactification\fP\&.
|
||
|
|
.SS "virtual bool serif::mapping::compactification::ExteriorDomainMap::is_affine_in_displacement () const\fR [nodiscard]\fP, \fR [pure virtual]\fP, \fR [noexcept]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Check if the mapping is affine in the displacement, that is if the mapping is linear in the displacement and does not depend on the displacement\&.
|
||
|
|
.PP
|
||
|
|
\fBReturns\fP
|
||
|
|
.RS 4
|
||
|
|
True if the mapping is affine in the displacement, false otherwise\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Implemented in \fBserif::mapping::compactification::KelvinCompactification\fP\&.
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|