Emily Boudreaux
6b57738330
Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
64 lines
3.9 KiB
Groff
64 lines
3.9 KiB
Groff
.TH "src/include/serif/solver/equilibrium.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/solver/equilibrium.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'serif/backend/mfem/solver/equilibrium\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/solver/nonlinear/newton\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/model/finite_elements\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBserif::solver::VolumeOptions\fP = \fBoperators::backend::mfem::VolumeOptions\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename Configuration, typename Layout, typename Options = SolverOptions<>, typename Observer = NoObserver, utils::dependencies::IsDependencyContext Inputs = utils::dependencies::DependencyContext<>, typename ObserverFactory = utils::dependencies::NoGraphObservers>
|
|
.br
|
|
requires utils::dependencies::ContainsKey<\fBdiscretization::blocks::surface_deformation::coefficients\fP, typename Layout::Values>auto \fBserif::solver::solve_equilibrium\fP (Configuration configuration, \fBmodel::StellarState\fP< Layout > initial_state, Options options={}, Observer observer={}, \fBVolumeOptions\fP volume_options={}, Inputs prescribed=Inputs{}, ObserverFactory observer_factory={})"
|
|
.br
|
|
.RI "Solve a moving star from an owning physical initial state\&. "
|
|
.ti -1c
|
|
.RI "template<typename Configuration, typename Layout, typename Options = SolverOptions<>, typename Observer = NoObserver, utils::dependencies::IsDependencyContext Inputs = utils::dependencies::DependencyContext<>, typename ObserverFactory = utils::dependencies::NoGraphObservers>
|
|
.br
|
|
requires (!utils::dependencies::ContainsKey<\fBdiscretization::blocks::surface_deformation::coefficients\fP, typename Layout::Values>)auto \fBserif::solver::solve_equilibrium\fP (Configuration configuration, \fBmodel::StellarState\fP< Layout > initial_state, const \fBVector\fP &displacement, Options options={}, Observer observer={}, \fBVolumeOptions\fP volume_options={}, Inputs prescribed=Inputs{}, ObserverFactory observer_factory={})"
|
|
.br
|
|
.RI "Solve a fixed-geometry model with prescribed displacement outside its unknown vector\&. "
|
|
.ti -1c
|
|
.RI "template<typename Configuration, typename Layout, typename Options = SolverOptions<>, typename Observer = NoObserver, utils::dependencies::IsDependencyContext Inputs = utils::dependencies::DependencyContext<>, typename ObserverFactory = utils::dependencies::NoGraphObservers>
|
|
.br
|
|
requires utils::dependencies::ContainsKey<\fBdiscretization::blocks::surface_deformation::coefficients\fP, typename Layout::Values>auto \fBserif::solver::resume_equilibrium\fP (Configuration configuration, \fBNewtonCheckpoint\fP< \fBmodel::StellarState\fP< Layout > > checkpoint, Options options={}, Observer observer={}, \fBVolumeOptions\fP volume_options={}, Inputs prescribed=Inputs{}, ObserverFactory observer_factory={})"
|
|
.br
|
|
.RI "Continue a moving-star checkpoint using reconstructed physical and numerical configuration\&. "
|
|
.ti -1c
|
|
.RI "template<typename Configuration, typename Layout, typename Options = SolverOptions<>, typename Observer = NoObserver, utils::dependencies::IsDependencyContext Inputs = utils::dependencies::DependencyContext<>, typename ObserverFactory = utils::dependencies::NoGraphObservers>
|
|
.br
|
|
requires (!utils::dependencies::ContainsKey<\fBdiscretization::blocks::surface_deformation::coefficients\fP, typename Layout::Values>)auto \fBserif::solver::resume_equilibrium\fP (Configuration configuration, \fBNewtonCheckpoint\fP< \fBmodel::StellarState\fP< Layout > > checkpoint, const \fBVector\fP &displacement, Options options={}, Observer observer={}, \fBVolumeOptions\fP volume_options={}, Inputs prescribed=Inputs{}, ObserverFactory observer_factory={})"
|
|
.br
|
|
.RI "Continue a fixed-geometry checkpoint with its separately restored prescribed displacement\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|