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

161 lines
6.1 KiB
Groff
Raw Normal View History

.TH "serif::mapping::GridFunctionMappingEvaluator" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::mapping::GridFunctionMappingEvaluator
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <evaluator\&.hpp>\fP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBGridFunctionMappingEvaluator\fP (const \fBDomainMapper\fP &mapper, const mfem::GridFunction &displacement, const mfem::GridFunction &compactification_coordinate)"
.br
.ti -1c
.RI "const mfem::Mesh * \fBmesh\fP () const noexcept"
.br
.RI "Identify the mesh supplying the mapping fields so callers can validate shared geometry\&. "
.ti -1c
.RI "void \fBinvalidate_cache\fP () noexcept"
.br
.ti -1c
.RI "void \fBrefresh\fP ()"
.br
.ti -1c
.RI "\fBMappingStatus\fP \fBevaluate_point\fP (mfem::ElementTransformation &transformation, const mfem::IntegrationPoint &integration_point, \fBMappingPointContext\fP &context)"
.br
.ti -1c
.RI "\fBMappingStatus\fP \fBevaluate_volume\fP (mfem::ElementTransformation &transformation, const mfem::IntegrationPoint &integration_point, \fBVolumeMappingContext\fP &context)"
.br
.ti -1c
.RI "\fBMappingStatus\fP \fBevaluate_face\fP (mfem::FaceElementTransformations &transformation, \fBFaceElementSide\fP side, const mfem::IntegrationPoint &integration_point, \fBFaceMappingContext\fP &context)"
.br
.in -1c
.SS "Private Member Functions"
.in +1c
.ti -1c
.RI "void \fBvalidate_field_bindings\fP () const"
.br
.ti -1c
.RI "bool \fBinvalidate_for_changed_spaces\fP ()"
.br
.ti -1c
.RI "void \fBload_element\fP (int element_id)"
.br
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "const \fBDomainMapper\fP & \fBm_mapper\fP"
.br
.ti -1c
.RI "const mfem::GridFunction & \fBm_displacement\fP"
.br
.ti -1c
.RI "const mfem::GridFunction & \fBm_compactification_coordinate\fP"
.br
.ti -1c
.RI "const mfem::FiniteElementSpace * \fBm_displacement_space\fP"
.br
.ti -1c
.RI "const mfem::FiniteElementSpace * \fBm_compactification_space\fP"
.br
.ti -1c
.RI "long \fBm_displacement_space_sequence\fP"
.br
.ti -1c
.RI "long \fBm_compactification_space_sequence\fP"
.br
.ti -1c
.RI "\fBDMWorkspace\fP \fBm_workspace\fP"
.br
.ti -1c
.RI "mfem::Array< int > \fBm_displacement_dofs\fP"
.br
.ti -1c
.RI "mfem::Array< int > \fBm_compactification_dofs\fP"
.br
.ti -1c
.RI "mfem::Vector \fBm_element_displacement\fP"
.br
.ti -1c
.RI "mfem::Vector \fBm_element_compactification\fP"
.br
.ti -1c
.RI "std::unique_ptr< \fBElementDisplacementData\fP > \fBm_displacement_data\fP"
.br
.ti -1c
.RI "std::unique_ptr< \fBElementCompactificationData\fP > \fBm_compactification_data\fP"
.br
.ti -1c
.RI "int \fBm_cached_element_id\fP {\-1}"
.br
.in -1c
.SH "Constructor & Destructor Documentation"
.PP
.SS "serif::mapping::GridFunctionMappingEvaluator::GridFunctionMappingEvaluator (const \fBDomainMapper\fP & mapper, const mfem::GridFunction & displacement, const mfem::GridFunction & compactification_coordinate)"
.SH "Member Function Documentation"
.PP
.SS "\fBMappingStatus\fP serif::mapping::GridFunctionMappingEvaluator::evaluate_face (mfem::FaceElementTransformations & transformation, \fBFaceElementSide\fP side, const mfem::IntegrationPoint & integration_point, \fBFaceMappingContext\fP & context)\fR [nodiscard]\fP"
.SS "\fBMappingStatus\fP serif::mapping::GridFunctionMappingEvaluator::evaluate_point (mfem::ElementTransformation & transformation, const mfem::IntegrationPoint & integration_point, \fBMappingPointContext\fP & context)\fR [nodiscard]\fP"
.SS "\fBMappingStatus\fP serif::mapping::GridFunctionMappingEvaluator::evaluate_volume (mfem::ElementTransformation & transformation, const mfem::IntegrationPoint & integration_point, \fBVolumeMappingContext\fP & context)\fR [nodiscard]\fP"
.SS "void serif::mapping::GridFunctionMappingEvaluator::invalidate_cache ()\fR [noexcept]\fP"
.SS "bool serif::mapping::GridFunctionMappingEvaluator::invalidate_for_changed_spaces ()\fR [nodiscard]\fP, \fR [private]\fP"
.SS "void serif::mapping::GridFunctionMappingEvaluator::load_element (int element_id)\fR [private]\fP"
.SS "const mfem::Mesh * serif::mapping::GridFunctionMappingEvaluator::mesh () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
Identify the mesh supplying the mapping fields so callers can validate shared geometry\&.
.SS "void serif::mapping::GridFunctionMappingEvaluator::refresh ()"
.SS "void serif::mapping::GridFunctionMappingEvaluator::validate_field_bindings () const\fR [private]\fP"
.SH "Member Data Documentation"
.PP
.SS "int serif::mapping::GridFunctionMappingEvaluator::m_cached_element_id {\-1}\fR [private]\fP"
.SS "const mfem::GridFunction& serif::mapping::GridFunctionMappingEvaluator::m_compactification_coordinate\fR [private]\fP"
.SS "std::unique_ptr<\fBElementCompactificationData\fP> serif::mapping::GridFunctionMappingEvaluator::m_compactification_data\fR [private]\fP"
.SS "mfem::Array<int> serif::mapping::GridFunctionMappingEvaluator::m_compactification_dofs\fR [private]\fP"
.SS "const mfem::FiniteElementSpace* serif::mapping::GridFunctionMappingEvaluator::m_compactification_space\fR [private]\fP"
.SS "long serif::mapping::GridFunctionMappingEvaluator::m_compactification_space_sequence\fR [private]\fP"
.SS "const mfem::GridFunction& serif::mapping::GridFunctionMappingEvaluator::m_displacement\fR [private]\fP"
.SS "std::unique_ptr<\fBElementDisplacementData\fP> serif::mapping::GridFunctionMappingEvaluator::m_displacement_data\fR [private]\fP"
.SS "mfem::Array<int> serif::mapping::GridFunctionMappingEvaluator::m_displacement_dofs\fR [private]\fP"
.SS "const mfem::FiniteElementSpace* serif::mapping::GridFunctionMappingEvaluator::m_displacement_space\fR [private]\fP"
.SS "long serif::mapping::GridFunctionMappingEvaluator::m_displacement_space_sequence\fR [private]\fP"
.SS "mfem::Vector serif::mapping::GridFunctionMappingEvaluator::m_element_compactification\fR [private]\fP"
.SS "mfem::Vector serif::mapping::GridFunctionMappingEvaluator::m_element_displacement\fR [private]\fP"
.SS "const \fBDomainMapper\fP& serif::mapping::GridFunctionMappingEvaluator::m_mapper\fR [private]\fP"
.SS "\fBDMWorkspace\fP serif::mapping::GridFunctionMappingEvaluator::m_workspace\fR [private]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.