62 lines
1.9 KiB
Groff
62 lines
1.9 KiB
Groff
|
.TH "serif::operators::GradientRequest" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::operators::GradientRequest
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.SS "Public Types"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBTest\fP = \fBDensity\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBOperands\fP = \fButils::types::TypeList\fP<\fBPotentialGradient\fP>"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Public Member Functions"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "\fBequations::PointLinearization\fP< \fBOperands\fP > \fBevaluate\fP (const \fBequations::EquationPoint\fP< \fBOperands\fP > &) const"
|
||
|
|
.br
|
||
|
|
.RI "Supply a syntactically valid authoring interface for the capability check\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "int \fBadditional_order\fP (\fBPotentialGradient\fP, int) const"
|
||
|
|
.br
|
||
|
|
.RI "No extra polynomial factor accompanies this gradient sample\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Static Public Attributes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "static constexpr std::string_view \fBname\fP = 'scalar gradient request'"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SH "Member Typedef Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "using \fBserif::operators::GradientRequest::Operands\fP = \fButils::types::TypeList\fP<\fBPotentialGradient\fP>"
|
||
|
|
|
||
|
|
.SS "using \fBserif::operators::GradientRequest::Test\fP = \fBDensity\fP"
|
||
|
|
|
||
|
|
.SH "Member Function Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "int serif::operators::GradientRequest::additional_order (\fBPotentialGradient\fP , int ) const\fR [inline]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
No extra polynomial factor accompanies this gradient sample\&.
|
||
|
|
.SS "\fBequations::PointLinearization\fP< \fBOperands\fP > serif::operators::GradientRequest::evaluate (const \fBequations::EquationPoint\fP< \fBOperands\fP > & ) const\fR [inline]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Supply a syntactically valid authoring interface for the capability check\&.
|
||
|
|
.SH "Member Data Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "std::string_view serif::operators::GradientRequest::name = 'scalar gradient request'\fR [static]\fP, \fR [constexpr]\fP"
|
||
|
|
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|