96 lines
3.2 KiB
Groff
96 lines
3.2 KiB
Groff
|
.TH "src/include/serif/model/equilibrium_equations.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
src/include/serif/model/equilibrium_equations.hpp
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
\fR#include <functional>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <tuple>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <type_traits>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <utility>\fP
|
||
|
|
.br
|
||
|
|
|
||
|
|
.SS "Classes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::model::NoShapeForce\fP"
|
||
|
|
.br
|
||
|
|
.RI "Explicitly omit a shape equation from a declarative formulation\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::model::NoSurfaceCondition\fP"
|
||
|
|
.br
|
||
|
|
.RI "Explicitly omit a surface prescription from a declarative formulation\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::model::EquilibriumEquations< Interior, Shape, Surface >\fP"
|
||
|
|
.br
|
||
|
|
.RI "State the chosen equations explicitly, without selecting physics from the EOS\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Namespaces"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBserif\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBserif::model\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBserif::model::detail\fP"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Concepts"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "concept \fBserif::model::EquilibriumEquationDescription\fP"
|
||
|
|
.br
|
||
|
|
.RI "Recognize composition without instantiating any numerical equation contract\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Functions"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename Interior, typename Shape = NoShapeForce, typename Surface = NoSurfaceCondition> \fBserif::model::EquilibriumEquations\fP (Interior, Shape={}, Surface={}) \-> EquilibriumEquations< Interior, Shape, Surface >"
|
||
|
|
.br
|
||
|
|
.RI "Preserve every authored member when a declaration passes through a templated model factory\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename Definition, typename Model> decltype(auto) \fBserif::model::detail::resolve_equation_member\fP (Definition &&definition, const Model &model)"
|
||
|
|
.br
|
||
|
|
.RI "Evaluate a physical definition or retain its immutable object without requiring a copy\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename Definition, typename Model> auto \fBserif::model::detail::resolve_equation_members\fP (Definition &&definition, const Model &model)"
|
||
|
|
.br
|
||
|
|
.RI "Resolve each explicit part, owning temporary results and borrowing unchanged model members\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename Model>
|
||
|
|
.br
|
||
|
|
requires requires(const Model& model) { model\&.equations(); } && EquilibriumEquationDescription<decltype(\fBdetail::resolve_equation_member\fP(std::declval<const Model&>()\&.equations(), std::declval<const Model&>()))>auto \fBserif::model::resolve_equilibrium_equations\fP (const Model &model)"
|
||
|
|
.br
|
||
|
|
.RI "Resolve an explicit composition at binding; retain the model while the result borrows its members\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename Model>
|
||
|
|
.br
|
||
|
|
requires (!std::is_lvalue_reference_v<Model>)void \fBserif::model::resolve_equilibrium_equations\fP (Model &&)=delete"
|
||
|
|
.br
|
||
|
|
.RI "A temporary model cannot retain the equation members borrowed by the resolved description\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Variables"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename Candidate> constexpr bool \fBserif::model::detail::is_equilibrium_equations\fP = false"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename Interior, typename Shape, typename Surface> constexpr bool \fBserif::model::detail::is_equilibrium_equations< EquilibriumEquations< Interior, Shape, Surface > >\fP = true"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|