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

58 lines
1.6 KiB
Groff
Raw Normal View History

.TH "serif::mapping::FaceQuadratureContext" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::mapping::FaceQuadratureContext \- A structure representing the context of a face quadrature point, including the normal vector, surface weight, and scale factor for the dot product of the velocity and normal vector\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <context\&.hpp>\fP
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "mfem::Vector \fBnormal\fP"
.br
.RI "The normal vector at the face quadrature point\&. "
.ti -1c
.RI "double \fBds\fP"
.br
.RI "The surface weight for the face quadrature point\&. "
.ti -1c
.RI "double \fBv_dot_n_scale\fP"
.br
.RI "The scale factor for the dot product of the velocity and normal vector at the face quadrature point\&. "
.in -1c
.SH "Detailed Description"
.PP
A structure representing the context of a face quadrature point, including the normal vector, surface weight, and scale factor for the dot product of the velocity and normal vector\&.
.PP
\fBTodo\fP
.RS 4
Add a worked example here
.RE
.PP
.SH "Member Data Documentation"
.PP
.SS "double serif::mapping::FaceQuadratureContext::ds"
.PP
The surface weight for the face quadrature point\&.
.SS "mfem::Vector serif::mapping::FaceQuadratureContext::normal"
.PP
The normal vector at the face quadrature point\&.
.SS "double serif::mapping::FaceQuadratureContext::v_dot_n_scale"
.PP
The scale factor for the dot product of the velocity and normal vector at the face quadrature point\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.