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

67 lines
2.7 KiB
Groff
Raw Permalink Normal View History

.TH "serif::equations::gravity_contributions" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::equations::gravity_contributions
.SH SYNOPSIS
.br
.PP
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBDensitySource\fP"
.br
.ti -1c
.RI "class \fBGradientDivergence\fP"
.br
.RI "The point wise contribution to the Poisson balance equation\&. Note that these contributions are just the point-wise divergence of the gradient field\&. You can get to this by going through the weak form derivation\&. The derivative is just the identity matrix since the residual is just the divergence of the gradient field\&. "
.ti -1c
.RI "class \fBGradientValue\fP"
.br
.RI "The point wise contribution to the gravity-gradient relation\&. Note that these contributions are just the point-wise field values\&. You can get to this by going through the weak form derivation\&. The derivative is just the identity matrix since the residual is just the field value\&. "
.ti -1c
.RI "class \fBPotentialValue\fP"
.br
.RI "The point wise contribution to the Poisson balance equation\&. Note that these contributions are just the point-wise potential values\&. You can get to this by going through the weak form derivation\&. The derivative is just one since the residual is just the variable\&. "
.in -1c
.SS "Typedefs"
.in +1c
.ti -1c
.RI "using \fBGradient\fP = \fBdiscretization::blocks::gravity::gradient\fP"
.br
.ti -1c
.RI "using \fBPotential\fP = \fBdiscretization::blocks::gravity::potential\fP"
.br
.ti -1c
.RI "using \fBDensity\fP = \fBdiscretization::blocks::density::mass\fP"
.br
.ti -1c
.RI "using \fBValue\fP = \fBdiscretization::forms::Operation::Value\fP"
.br
.ti -1c
.RI "using \fBDivergence\fP = \fBdiscretization::forms::Operation::Divergence\fP"
.br
.ti -1c
.RI "template<typename Term, typename Operation = Value> using \fBOperand\fP = \fBdiscretization::forms::Operand\fP<Term, Operation>"
.br
.in -1c
.SH "Typedef Documentation"
.PP
.SS "using \fBserif::equations::gravity_contributions::Density\fP = \fBdiscretization::blocks::density::mass\fP"
.SS "using \fBserif::equations::gravity_contributions::Divergence\fP = \fBdiscretization::forms::Operation::Divergence\fP"
.SS "using \fBserif::equations::gravity_contributions::Gradient\fP = \fBdiscretization::blocks::gravity::gradient\fP"
.SS "template<typename Term, typename Operation = Value> using \fBserif::equations::gravity_contributions::Operand\fP = \fBdiscretization::forms::Operand\fP<Term, Operation>"
.SS "using \fBserif::equations::gravity_contributions::Potential\fP = \fBdiscretization::blocks::gravity::potential\fP"
.SS "using \fBserif::equations::gravity_contributions::Value\fP = \fBdiscretization::forms::Operation::Value\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.