.TH "src/include/serif/discretization/forms/operands.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*- .ad l .nh .SH NAME src/include/serif/discretization/forms/operands.hpp \- This file defines the Operand type, which represents a term and an operation to be applied to that term in the context of a form\&. .SH SYNOPSIS .br .PP \fR#include \fP .br \fR#include \fP .br \fR#include 'serif/discretization/blocks/concepts\&.hpp'\fP .br .SS "Classes" .in +1c .ti -1c .RI "struct \fBserif::discretization::forms::Operation\fP" .br .RI "The \fBOperation\fP struct defines a set of operations that can be applied to terms in the context of a form\&. These operations include value, gradient, divergence, curl, and normal trace\&. Similar to the statement I made at the top of \fBforms\&.hpp\fP, if you are a developer looking to extend the mathematical capabilities of SERiF this is a place you should be looking early on\&. " .ti -1c .RI "struct \fBserif::discretization::forms::Operation::Value\fP" .br .RI "\fBOperation\fP tag for evaluating a value\&. " .ti -1c .RI "struct \fBserif::discretization::forms::Operation::Gradient\fP" .br .RI "\fBOperation\fP tag for evaluating a gradient\&. " .ti -1c .RI "struct \fBserif::discretization::forms::Operation::Divergence\fP" .br .RI "\fBOperation\fP tag for evaluating a divergence\&. " .ti -1c .RI "struct \fBserif::discretization::forms::Operation::Curl\fP" .br .RI "\fBOperation\fP tag for evaluating a curl\&. " .ti -1c .RI "struct \fBserif::discretization::forms::Operation::NormalTrace\fP" .br .RI "\fBOperation\fP tag for evaluating the normal flux along a boundary\&. " .ti -1c .RI "struct \fBserif::discretization::forms::Operand< TermT, OperationT >\fP" .br .RI "Compile time representation of some operand\&. An operand associates a term to an operation type (e\&.g\&. the gradient of gravitational potential where gravitational potential is the term and gradient is the operation)\&. " .in -1c .SS "Namespaces" .in +1c .ti -1c .RI "namespace \fBserif\fP" .br .ti -1c .RI "namespace \fBserif::discretization\fP" .br .ti -1c .RI "namespace \fBserif::discretization::forms\fP" .br .in -1c .SS "Concepts" .in +1c .ti -1c .RI "concept \fBserif::discretization::forms::IsOperation\fP" .br .ti -1c .RI "concept \fBserif::discretization::forms::IsOperand\fP" .br .RI "Concept to validate a valid operand\&. An operand is valid if the following conditions are satisfied\&. " .in -1c .SH "Detailed Description" .PP This file defines the Operand type, which represents a term and an operation to be applied to that term in the context of a form\&. .PP \fBAuthor\fP .RS 4 Emily M\&. Boudreaux .RE .PP An Operand is a compile-time type that encapsulates a term and an operation to be applied to that term\&. The operation can be one of several predefined operations, such as value, gradient, divergence, curl, or normal trace\&. The Operand type is used in the definition of forms to specify the terms and operations involved in the form\&. .SH "Author" .PP Generated automatically by Doxygen for SERiF from the source code\&.