Files
MeanField_SERiF/docs/man/man3/serif_operators_NodalRequest.3

77 lines
3.6 KiB
Groff
Raw Normal View History

.TH "serif::operators::NodalRequest< TermT, OperationT, PositionIndependent >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::operators::NodalRequest< TermT, OperationT, PositionIndependent >
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBserif::equations::Contribution< discretization::forms::Operand< TermT, discretization::forms::Operation::Value >, discretization::domain::StellarSurfaceBoundary >\fP\&.
.SS "Public Types"
.in +1c
.ti -1c
.RI "using \fBOperands\fP = \fButils::types::TypeList\fP<\fBdiscretization::forms::Operand\fP<TermT>>"
.br
.ti -1c
.RI "using \fBResult\fP = \fBdiscretization::forms::OperandValue\fP<\fBdiscretization::forms::Operand\fP<TermT, OperationT>>"
.br
.in -1c
Public Types inherited from \fBserif::equations::Contribution< discretization::forms::Operand< TermT, discretization::forms::Operation::Value >, discretization::domain::StellarSurfaceBoundary >\fP
.in +1c
.ti -1c
.RI "using \fBTest\fP"
.br
.RI "The test type of the contribution\&. "
.ti -1c
.RI "using \fBTestOperand\fP"
.br
.RI "The operand type of the contribution (associating a test function and a term) "
.ti -1c
.RI "using \fBSupport\fP"
.br
.RI "The domain support of the contribution (which then boils down to the dofs which are supported by the term on that test function) "
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBequations::PointLinearization\fP< \fBOperands\fP, \fBResult\fP > \fBevaluate\fP (const \fBequations::EquationPoint\fP< \fBOperands\fP > &) const"
.br
.RI "Supply a point linearization so capability checks depend only on the declared operand and support\&. "
.in -1c
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "static constexpr std::string_view \fBname\fP = 'nodal capability test'"
.br
.ti -1c
.RI "static constexpr bool \fBposition_independent\fP = PositionIndependent"
.br
.in -1c
.SH "Member Typedef Documentation"
.PP
.SS "template<typename TermT, typename OperationT = discretization::forms::Operation::Value, bool PositionIndependent = true> using \fBserif::operators::NodalRequest\fP< TermT, OperationT, PositionIndependent >::Operands = \fButils::types::TypeList\fP<\fBdiscretization::forms::Operand\fP<TermT>>"
.SS "template<typename TermT, typename OperationT = discretization::forms::Operation::Value, bool PositionIndependent = true> using \fBserif::operators::NodalRequest\fP< TermT, OperationT, PositionIndependent >::Result = \fBdiscretization::forms::OperandValue\fP<\fBdiscretization::forms::Operand\fP<TermT, OperationT>>"
.SH "Member Function Documentation"
.PP
.SS "template<typename TermT, typename OperationT = discretization::forms::Operation::Value, bool PositionIndependent = true> \fBequations::PointLinearization\fP< \fBOperands\fP, \fBResult\fP > \fBserif::operators::NodalRequest\fP< TermT, OperationT, PositionIndependent >::evaluate (const \fBequations::EquationPoint\fP< \fBOperands\fP > & ) const\fR [inline]\fP"
.PP
Supply a point linearization so capability checks depend only on the declared operand and support\&.
.SH "Member Data Documentation"
.PP
.SS "template<typename TermT, typename OperationT = discretization::forms::Operation::Value, bool PositionIndependent = true> std::string_view \fBserif::operators::NodalRequest\fP< TermT, OperationT, PositionIndependent >::name = 'nodal capability test'\fR [static]\fP, \fR [constexpr]\fP"
.SS "template<typename TermT, typename OperationT = discretization::forms::Operation::Value, bool PositionIndependent = true> bool \fBserif::operators::NodalRequest\fP< TermT, OperationT, PositionIndependent >::position_independent = PositionIndependent\fR [static]\fP, \fR [constexpr]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.