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

65 lines
2.5 KiB
Groff
Raw Normal View History

.TH "serif::discretization::blocks::displacement" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::blocks::displacement \- The displacement field is a 3 vector H1 field (C0 continuous) that is used to represent continuous nodal displacement over the entire domain\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <fields\&.hpp>\fP
.PP
Inherits \fBserif::discretization::blocks::field\fP\&.
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBvector\fP"
.br
.RI "the displacement vector term is a 3 vector H1 field (C0 continuous) that is used to represent continuous nodal displacement over the entire domain\&. This is a vector field that is associated with the mapping of the domain from the reference to physical spaces\&. E\&.g\&. if there is some domain O_ref which n nodal positions x^i_ref then there is some other domain O_phys with n nodel positions such that x^i_phys = x^i_ref + d^i where d^i is the displacement vector at node i\&. "
.in -1c
.SS "Public Types"
.in +1c
.ti -1c
.RI "using \fBTerms\fP = \fButils::types::TypeList\fP<\fBvector\fP>"
.br
.RI "Type list of terms for compile time reflection and iteration over the terms of the field\&. "
.in -1c
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "static constexpr std::string_view \fBname\fP = \fBmeta::type_name\fP<\fBdisplacement\fP>()"
.br
.RI "Compile time reflected name of the field\&. "
.ti -1c
.RI "static constexpr \fBvector\fP \fBvector_term\fP {}"
.br
.RI "Static constexpr instance of the vector term\&. This is used to access the term in the discretization\&. "
.in -1c
.SH "Detailed Description"
.PP
The displacement field is a 3 vector H1 field (C0 continuous) that is used to represent continuous nodal displacement over the entire domain\&.
.SH "Member Typedef Documentation"
.PP
.SS "using \fBserif::discretization::blocks::displacement::Terms\fP = \fButils::types::TypeList\fP<\fBvector\fP>"
.PP
Type list of terms for compile time reflection and iteration over the terms of the field\&.
.SH "Member Data Documentation"
.PP
.SS "std::string_view serif::discretization::blocks::displacement::name = \fBmeta::type_name\fP<\fBdisplacement\fP>()\fR [static]\fP, \fR [constexpr]\fP"
.PP
Compile time reflected name of the field\&.
.SS "\fBvector\fP serif::discretization::blocks::displacement::vector_term {}\fR [static]\fP, \fR [constexpr]\fP"
.PP
Static constexpr instance of the vector term\&. This is used to access the term in the discretization\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.