tboudreaux/MeanField_SERiF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(docs): built docs

Browse Source 
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)
This commit is contained in:
Emily Boudreaux
2026-11-09 14:09:44 -05:00
parent d9c4919477
commit 6b57738330
32596 changed files with 4155414 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/man/man3/@054152172322350147075335271046024114014216105077_CanResolve.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "@054152172322350147075335271046024114014216105077::CanResolve" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@054152172322350147075335271046024114014216105077::CanResolve
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename BindingsT, typename DeclarationT>
concept @054152172322350147075335271046024114014216105077::CanResolve = requires {
typename dependencies::ResolvedTargets<BindingsT, DeclarationT>;
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

19
docs/man/man3/@076111035010356211004365113056122140226040272225_CanReadUniqueBoundary.3 Normal file
View File

@@ -0,0 +1,19 @@
.TH "@076111035010356211004365113056122140226040272225::CanReadUniqueBoundary" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@076111035010356211004365113056122140226040272225::CanReadUniqueBoundary
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename Candidate>
concept @076111035010356211004365113056122140226040272225::CanReadUniqueBoundary = requires(const Candidate& candidate) { candidate\&.template specification_for_role<model::SpecificationRole::boundary_condition>(); }
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

19
docs/man/man3/@076111035010356211004365113056122140226040272225_CanResolveDescription.3 Normal file
View File

@@ -0,0 +1,19 @@
.TH "@076111035010356211004365113056122140226040272225::CanResolveDescription" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@076111035010356211004365113056122140226040272225::CanResolveDescription
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename Candidate>
concept @076111035010356211004365113056122140226040272225::CanResolveDescription = requires(const Candidate& candidate) { model::resolve_equilibrium_equations(candidate); }
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

19
docs/man/man3/@076111035010356211004365113056122140226040272225_CanResolveTemporary.3 Normal file
View File

@@ -0,0 +1,19 @@
.TH "@076111035010356211004365113056122140226040272225::CanResolveTemporary" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@076111035010356211004365113056122140226040272225::CanResolveTemporary
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename Candidate>
concept @076111035010356211004365113056122140226040272225::CanResolveTemporary = requires { model::resolve_equilibrium_equations(std::declval<Candidate>()); }
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

23
docs/man/man3/@104051022023260372251021217357261053015367015144_Applicable.3 Normal file
View File

@@ -0,0 +1,23 @@
.TH "@104051022023260372251021217357261053015367015144::Applicable" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@104051022023260372251021217357261053015367015144::Applicable \- Strict stage settings must cover each bound coordinate, not only a subset\&.
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename Setting, typename Bound>
concept @104051022023260372251021217357261053015367015144::Applicable = requires(Setting setting, serif::solver::continuation::Options<Bound>& options) { setting\&.apply(options); }
.PP
.fi
.SH "Detailed Description"
.PP
Strict stage settings must cover each bound coordinate, not only a subset\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

23
docs/man/man3/@104051022023260372251021217357261053015367015144_Attachable.3 Normal file
View File

@@ -0,0 +1,23 @@
.TH "@104051022023260372251021217357261053015367015144::Attachable" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@104051022023260372251021217357261053015367015144::Attachable \- Dependent laws must read selected inputs, have distinct outputs, and avoid independent outputs\&.
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename Selection, typename Law>
concept @104051022023260372251021217357261053015367015144::Attachable = requires(Selection selection, Law law) { std::move(selection)\&.with(std::move(law)); }
.PP
.fi
.SH "Detailed Description"
.PP
Dependent laws must read selected inputs, have distinct outputs, and avoid independent outputs\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

23
docs/man/man3/@104051022023260372251021217357261053015367015144_Bindable.3 Normal file
View File

@@ -0,0 +1,23 @@
.TH "@104051022023260372251021217357261053015367015144::Bindable" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@104051022023260372251021217357261053015367015144::Bindable \- A family must account for parameter ownership, required dependent laws, and physical identity\&.
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename Selection, typename Target>
concept @104051022023260372251021217357261053015367015144::Bindable = requires(Selection selection, Target target) { std::move(selection)\&.bind(std::move(target)); }
.PP
.fi
.SH "Detailed Description"
.PP
A family must account for parameter ownership, required dependent laws, and physical identity\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

23
docs/man/man3/@104051022023260372251021217357261053015367015144_ConstantLaw.3 Normal file
View File

@@ -0,0 +1,23 @@
.TH "@104051022023260372251021217357261053015367015144::ConstantLaw" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@104051022023260372251021217357261053015367015144::ConstantLaw \- Laws must preserve physical units and callable signatures\&.
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename Function>
concept @104051022023260372251021217357261053015367015144::ConstantLaw = requires(Function function) { family::law(Constant{}, family::depends_on(Index{}), std::move(function)); }
.PP
.fi
.SH "Detailed Description"
.PP
Laws must preserve physical units and callable signatures\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

23
docs/man/man3/@104051022023260372251021217357261053015367015144_Selectable.3 Normal file
View File

@@ -0,0 +1,23 @@
.TH "@104051022023260372251021217357261053015367015144::Selectable" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@104051022023260372251021217357261053015367015144::Selectable \- Selected coordinates must be unique typed physical parameters\&.
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename\&.\&.\&. Parameters>
concept @104051022023260372251021217357261053015367015144::Selectable = requires(Parameters\&.\&.\&. parameters) { family::in(parameters\&.\&.\&.); }
.PP
.fi
.SH "Detailed Description"
.PP
Selected coordinates must be unique typed physical parameters\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

23
docs/man/man3/@104051022023260372251021217357261053015367015144_StartingValue.3 Normal file
View File

@@ -0,0 +1,23 @@
.TH "@104051022023260372251021217357261053015367015144::StartingValue" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@104051022023260372251021217357261053015367015144::StartingValue \- Starting values have the selected parameter's units\&.
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename Parameter, typename Value>
concept @104051022023260372251021217357261053015367015144::StartingValue = requires(Parameter parameter, Value value) { family::starting_at(parameter, value); }
.PP
.fi
.SH "Detailed Description"
.PP
Starting values have the selected parameter's units\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

25
docs/man/man3/@105303371101360306025050204101312212144366254006_CanScaleMass.3 Normal file
View File

@@ -0,0 +1,25 @@
.TH "@105303371101360306025050204101312212144366254006::CanScaleMass" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@105303371101360306025050204101312212144366254006::CanScaleMass \- Physical reference inputs must carry their distinct dimensions\&.
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename Mass, typename Density, typename Gravity>
concept @105303371101360306025050204101312212144366254006::CanScaleMass = requires(const laneemden::Solution &solution, Mass mass, Density density, Gravity gravity) {
{ laneemden::scale_from_mass(solution, mass, density, gravity) } \-> std::same_as<std::expected<laneemden::PhysicalScales, std::string>>;
}
.PP
.fi
.SH "Detailed Description"
.PP
Physical reference inputs must carry their distinct dimensions\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

23
docs/man/man3/@120027171211173332346346153147002002266065223266_CanMakeBindings.3 Normal file
View File

@@ -0,0 +1,23 @@
.TH "@120027171211173332346346153147002002266065223266::CanMakeBindings" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@120027171211173332346346153147002002266065223266::CanMakeBindings \- Invalid members remain a failed collection requirement, even when their aliases are missing\&.
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename\&.\&.\&. Types>
concept @120027171211173332346346153147002002266065223266::CanMakeBindings = requires { typename dependencies::Bindings<Types\&.\&.\&.>; }
.PP
.fi
.SH "Detailed Description"
.PP
Invalid members remain a failed collection requirement, even when their aliases are missing\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

21
docs/man/man3/@120027171211173332346346153147002002266065223266_HasBoundType.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "@120027171211173332346346153147002002266065223266::HasBoundType" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@120027171211173332346346153147002002266065223266::HasBoundType
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename BindingsT, typename KeyT>
concept @120027171211173332346346153147002002266065223266::HasBoundType = requires {
typename dependencies::bound_type_t<BindingsT, KeyT>;
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

21
docs/man/man3/@120027171211173332346346153147002002266065223266_HasBoundTypeMember.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "@120027171211173332346346153147002002266065223266::HasBoundTypeMember" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@120027171211173332346346153147002002266065223266::HasBoundTypeMember
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename BindingsT, typename KeyT>
concept @120027171211173332346346153147002002266065223266::HasBoundTypeMember = requires {
typename dependencies::BoundType<BindingsT, KeyT>::target_type;
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

19
docs/man/man3/@157116114150123267120271363131113324057353033032_DefaultRadialSeed.3 Normal file
View File

@@ -0,0 +1,19 @@
.TH "@157116114150123267120271363131113324057353033032::DefaultRadialSeed" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@157116114150123267120271363131113324057353033032::DefaultRadialSeed
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename Model>
concept @157116114150123267120271363131113324057353033032::DefaultRadialSeed = requires(const Model& model) { solver::seed::make_polytropic_seed(model); }
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

19
docs/man/man3/@200074317303167056063064256070046203054064052214_CanInspectChange.3 Normal file
View File

@@ -0,0 +1,19 @@
.TH "@200074317303167056063064256070046203054064052214::CanInspectChange" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@200074317303167056063064256070046203054064052214::CanInspectChange
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename KeyT>
concept @200074317303167056063064256070046203054064052214::CanInspectChange = requires(const Update& update) { update\&.template changed<KeyT>(); }
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

21
docs/man/man3/@200074317303167056063064256070046203054064052214_CanMakeCache.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "@200074317303167056063064256070046203054064052214::CanMakeCache" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@200074317303167056063064256070046203054064052214::CanMakeCache
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename ContextT, typename\&.\&.\&. Computations>
concept @200074317303167056063064256070046203054064052214::CanMakeCache = requires(const ContextT& context, Computations&&\&.\&.\&. computations) {
dependencies::make_computation_cache(context, std::forward<Computations>(computations)\&.\&.\&.);
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

21
docs/man/man3/@200074317303167056063064256070046203054064052214_CanMakeComputation.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "@200074317303167056063064256070046203054064052214::CanMakeComputation" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@200074317303167056063064256070046203054064052214::CanMakeComputation
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename FunctionT, typename InputsT dependencies::InputList<Source>>
concept @200074317303167056063064256070046203054064052214::CanMakeComputation = requires(FunctionT&& function) {
dependencies::make_computation<First, InputsT>(std::forward<FunctionT>(function));
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

21
docs/man/man3/@200074317303167056063064256070046203054064052214_CanMakeFallibleCache.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "@200074317303167056063064256070046203054064052214::CanMakeFallibleCache" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@200074317303167056063064256070046203054064052214::CanMakeFallibleCache
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename ErrorT, typename\&.\&.\&. Computations>
concept @200074317303167056063064256070046203054064052214::CanMakeFallibleCache = requires(const DependencyContext& context, Computations&&\&.\&.\&. computations) {
dependencies::make_computation_cache<ErrorT>(context, std::forward<Computations>(computations)\&.\&.\&.);
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

25
docs/man/man3/@200074317303167056063064256070046203054064052214_CanMakeObservedCache.3 Normal file
View File

@@ -0,0 +1,25 @@
.TH "@200074317303167056063064256070046203054064052214::CanMakeObservedCache" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@200074317303167056063064256070046203054064052214::CanMakeObservedCache \- Observer validation must also constrain the public cache factory\&.
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename ObserversT>
concept @200074317303167056063064256070046203054064052214::CanMakeObservedCache = requires(const ComputationGraph& graph, const DependencyContext& context, ObserversT&& observers) {
dependencies::make_computation_cache(graph, context, std::forward<ObserversT>(observers));
}
.PP
.fi
.SH "Detailed Description"
.PP
Observer validation must also constrain the public cache factory\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

25
docs/man/man3/@200074317303167056063064256070046203054064052214_CanObserveNode.3 Normal file
View File

@@ -0,0 +1,25 @@
.TH "@200074317303167056063064256070046203054064052214::CanObserveNode" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@200074317303167056063064256070046203054064052214::CanObserveNode \- Observer lifetime callbacks must agree on an owned state and cannot fail while closing it\&.
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename BeforeT, typename AfterT>
concept @200074317303167056063064256070046203054064052214::CanObserveNode = requires(BeforeT&& before, AfterT&& after) {
dependencies::observe_node<First>(std::forward<BeforeT>(before), std::forward<AfterT>(after));
}
.PP
.fi
.SH "Detailed Description"
.PP
Observer lifetime callbacks must agree on an owned state and cannot fail while closing it\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

21
docs/man/man3/@200074317303167056063064256070046203054064052214_CanRequest.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "@200074317303167056063064256070046203054064052214::CanRequest" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@200074317303167056063064256070046203054064052214::CanRequest
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename RequestedT>
concept @200074317303167056063064256070046203054064052214::CanRequest = requires(ComputationCache& cache, const DependencyContext& context, RequestedT request) {
cache\&.try_prepare(context, request);
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

26
docs/man/man3/@230372075125117112146216022050257331177137107327_CanBuildValidatedDisplacement.3 Normal file
View File

@@ -0,0 +1,26 @@
.TH "@230372075125117112146216022050257331177137107327::CanBuildValidatedDisplacement" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@230372075125117112146216022050257331177137107327::CanBuildValidatedDisplacement \- Only a map producing volume displacements can be checked against volume finite elements\&.
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename Map>
concept @230372075125117112146216022050257331177137107327::CanBuildValidatedDisplacement = requires(const Map& map, std::span<const double> parameters, const ::mfem::FiniteElementSpace& space)
{
deformation::backend::mfem::build_validated_displacement(map, parameters, space);
}
.PP
.fi
.SH "Detailed Description"
.PP
Only a map producing volume displacements can be checked against volume finite elements\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

26
docs/man/man3/@230372075125117112146216022050257331177137107327_CanCompose.3 Normal file
View File

@@ -0,0 +1,26 @@
.TH "@230372075125117112146216022050257331177137107327::CanCompose" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@230372075125117112146216022050257331177137107327::CanCompose \- Equal vector lengths cannot substitute for matching physical meanings at a composition boundary\&.
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename Surface, typename Extension>
concept @230372075125117112146216022050257331177137107327::CanCompose = requires(std::shared_ptr<const Surface> surface, std::shared_ptr<const Extension> extension)
{
deformation::compose_deformation(surface, extension);
}
.PP
.fi
.SH "Detailed Description"
.PP
Equal vector lengths cannot substitute for matching physical meanings at a composition boundary\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

19
docs/man/man3/@241261032367265377033327303223052314265056103141_CanInspectChange.3 Normal file
View File

@@ -0,0 +1,19 @@
.TH "@241261032367265377033327303223052314265056103141::CanInspectChange" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@241261032367265377033327303223052314265056103141::CanInspectChange
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename KeyT>
concept @241261032367265377033327303223052314265056103141::CanInspectChange = requires(const Update& update) { update\&.template changed<KeyT>(); }
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

21
docs/man/man3/@241261032367265377033327303223052314265056103141_CanRequest.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "@241261032367265377033327303223052314265056103141::CanRequest" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@241261032367265377033327303223052314265056103141::CanRequest
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename RequestedT>
concept @241261032367265377033327303223052314265056103141::CanRequest = requires(Prepared& prepared, const Context& context, RequestedT request) {
prepared\&.try_prepare(context, request);
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

21
docs/man/man3/@247006277077211216153350341142357337161001026143_HasSurfaceRelation.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "@247006277077211216153350341142357337161001026143::HasSurfaceRelation" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@247006277077211216153350341142357337161001026143::HasSurfaceRelation
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename EOS, typename Bindings>
concept @247006277077211216153350341142357337161001026143::HasSurfaceRelation = requires {
typename surface::pressure_relation_t<EOS, Bindings>;
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

21
docs/man/man3/@247006277077211216153350341142357337161001026143_SelectsCarrier.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "@247006277077211216153350341142357337161001026143::SelectsCarrier" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@247006277077211216153350341142357337161001026143::SelectsCarrier
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename Candidate>
concept @247006277077211216153350341142357337161001026143::SelectsCarrier = requires {
typename Candidate::CarrierQuantity;
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

22
docs/man/man3/@250110035027220242324102122027040335104251176344_HasStellarScale.3 Normal file
View File

@@ -0,0 +1,22 @@
.TH "@250110035027220242324102122027040335104251176344::HasStellarScale" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@250110035027220242324102122027040335104251176344::HasStellarScale
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename Quantity>
concept @250110035027220242324102122027040335104251176344::HasStellarScale = requires(const normalization::StellarReferenceScales &scales)
{
{ normalization::characteristic_scale(scales, Quantity{}) } \-> std::same_as<dimensions::QuantityValue<Quantity>>;
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

26
docs/man/man3/@252166143035264314021214246026055041120163322041_CanIndex.3 Normal file
View File

@@ -0,0 +1,26 @@
.TH "@252166143035264314021214246026055041120163322041::CanIndex" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@252166143035264314021214246026055041120163322041::CanIndex \- Invalid indexing remains a failed requirement rather than an out-of-range constant\&.
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename KeyT, typename KeysT>
concept @252166143035264314021214246026055041120163322041::CanIndex = requires
{
dependencies::key_index<KeyT, KeysT>();
}
.PP
.fi
.SH "Detailed Description"
.PP
Invalid indexing remains a failed requirement rather than an out-of-range constant\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

21
docs/man/man3/@252166143035264314021214246026055041120163322041_CanResolve.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "@252166143035264314021214246026055041120163322041::CanResolve" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@252166143035264314021214246026055041120163322041::CanResolve
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename BindingsT, typename KeysT>
concept @252166143035264314021214246026055041120163322041::CanResolve = requires {
typename dependencies::ResolvedTargets<BindingsT, KeysT>;
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

23
docs/man/man3/@253343222056052264073162264131026071236027076263_CacheableRow.3 Normal file
View File

@@ -0,0 +1,23 @@
.TH "@253343222056052264073162264131026071236027076263::CacheableRow" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@253343222056052264073162264131026071236027076263::CacheableRow \- Spatial equations must retain their ordinary volume representation\&.
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename Row>
concept @253343222056052264073162264131026071236027076263::CacheableRow = requires { typename computations::ScalarResidualRow<Row>; }
.PP
.fi
.SH "Detailed Description"
.PP
Spatial equations must retain their ordinary volume representation\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

25
docs/man/man3/@301112010136147065114044076153062246372076341171_CanConfigureDiscretization.3 Normal file
View File

@@ -0,0 +1,25 @@
.TH "@301112010136147065114044076153062246372076341171::CanConfigureDiscretization" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@301112010136147065114044076153062246372076341171::CanConfigureDiscretization \- Make invalid factory configurations detectable without entering numerical preparation\&.
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename Options>
concept @301112010136147065114044076153062246372076341171::CanConfigureDiscretization = requires(Options options) {
model::make_discretization(std::move(options));
}
.PP
.fi
.SH "Detailed Description"
.PP
Make invalid factory configurations detectable without entering numerical preparation\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

25
docs/man/man3/@301112010136147065114044076153062246372076341171_CoordinatePolicy.3 Normal file
View File

@@ -0,0 +1,25 @@
.TH "@301112010136147065114044076153062246372076341171::CoordinatePolicy" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@301112010136147065114044076153062246372076341171::CoordinatePolicy \- Keep unsupported coordinate policies and wrongly typed reference values out of user configurations\&.
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename Policy>
concept @301112010136147065114044076153062246372076341171::CoordinatePolicy = requires {
typename normalization::NormalizationOptions<ExplicitScheme, Policy>;
}
.PP
.fi
.SH "Detailed Description"
.PP
Keep unsupported coordinate policies and wrongly typed reference values out of user configurations\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

21
docs/man/man3/@301112010136147065114044076153062246372076341171_LaneEmdenInputs.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "@301112010136147065114044076153062246372076341171::LaneEmdenInputs" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@301112010136147065114044076153062246372076341171::LaneEmdenInputs
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename Mass, typename Density>
concept @301112010136147065114044076153062246372076341171::LaneEmdenInputs = requires {
typename normalization::LaneEmdenApproximation<Mass, Density>;
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

19
docs/man/man3/@323172327364102235210333337057065015152354331343_CanBorrow.3 Normal file
View File

@@ -0,0 +1,19 @@
.TH "@323172327364102235210333337057065015152354331343::CanBorrow" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@323172327364102235210333337057065015152354331343::CanBorrow
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename ValueT>
concept @323172327364102235210333337057065015152354331343::CanBorrow = requires(ValueT&& value) { dependencies::borrow<First>(std::forward<ValueT>(value)); }
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

22
docs/man/man3/@323172327364102235210333337057065015152354331343_CanCombineContexts.3 Normal file
View File

@@ -0,0 +1,22 @@
.TH "@323172327364102235210333337057065015152354331343::CanCombineContexts" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@323172327364102235210333337057065015152354331343::CanCombineContexts
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename\&.\&.\&. Contexts>
concept @323172327364102235210333337057065015152354331343::CanCombineContexts = requires(const Contexts&\&.\&.\&. contexts)
{
dependencies::combine_dependency_contexts(contexts\&.\&.\&.);
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

21
docs/man/man3/@323172327364102235210333337057065015152354331343_CanMakeContext.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "@323172327364102235210333337057065015152354331343::CanMakeContext" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@323172327364102235210333337057065015152354331343::CanMakeContext
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename\&.\&.\&. Resources>
concept @323172327364102235210333337057065015152354331343::CanMakeContext = requires(Resources&&\&.\&.\&. resources) {
dependencies::make_dependency_context(std::forward<Resources>(resources)\&.\&.\&.);
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

19
docs/man/man3/@323172327364102235210333337057065015152354331343_CanRead.3 Normal file
View File

@@ -0,0 +1,19 @@
.TH "@323172327364102235210333337057065015152354331343::CanRead" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@323172327364102235210333337057065015152354331343::CanRead
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename ContextT, typename KeyT>
concept @323172327364102235210333337057065015152354331343::CanRead = requires(const ContextT& context) { context\&.template get<KeyT>(); }
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

21
docs/man/man3/@323172327364102235210333337057065015152354331343_CanSelect.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "@323172327364102235210333337057065015152354331343::CanSelect" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@323172327364102235210333337057065015152354331343::CanSelect
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename ContextT>
concept @323172327364102235210333337057065015152354331343::CanSelect = requires(ContextT&& context) {
std::forward<ContextT>(context)\&.select(dependencies::KeyList<First>{});
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

26
docs/man/man3/@341327062240224103006004034245155142150333316133_CanBindShape.3 Normal file
View File

@@ -0,0 +1,26 @@
.TH "@341327062240224103006004034245155142150333316133::CanBindShape" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@341327062240224103006004034245155142150333316133::CanBindShape \- Input views may be temporary, but their owning containers may not be\&.
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename Coefficients>
concept @341327062240224103006004034245155142150333316133::CanBindShape = requires(const deformation::DomainDeformation<deformation::SphericalHarmonicSurface>& model,
const backend::ReferenceDiscretization& reference, Coefficients&& coefficients) {
backend::make_deformation_inputs(model, reference, std::forward<Coefficients>(coefficients));
}
.PP
.fi
.SH "Detailed Description"
.PP
Input views may be temporary, but their owning containers may not be\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

26
docs/man/man3/@341327062240224103006004034245155142150333316133_CanResolveDeformation.3 Normal file
View File

@@ -0,0 +1,26 @@
.TH "@341327062240224103006004034245155142150333316133::CanResolveDeformation" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@341327062240224103006004034245155142150333316133::CanResolveDeformation \- Missing physical boundary names must fail the public discretization factory's constraints\&.
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename Candidate>
concept @341327062240224103006004034245155142150333316133::CanResolveDeformation = requires(const mfem::FiniteElementSpace& scalar, const mfem::FiniteElementSpace& vector, mfem::Mesh& logical)
{
backend::deformation_discretization<Candidate>(scalar, vector, logical);
}
.PP
.fi
.SH "Detailed Description"
.PP
Missing physical boundary names must fail the public discretization factory's constraints\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

19
docs/man/man3/@343165112273273213015061264140367175175220026106_CanBorrow.3 Normal file
View File

@@ -0,0 +1,19 @@
.TH "@343165112273273213015061264140367175175220026106::CanBorrow" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@343165112273273213015061264140367175175220026106::CanBorrow
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename ValueT>
concept @343165112273273213015061264140367175175220026106::CanBorrow = requires(ValueT&& value) { dependencies::borrow<First>(std::forward<ValueT>(value)); }
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

21
docs/man/man3/@343165112273273213015061264140367175175220026106_CanMakeContext.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "@343165112273273213015061264140367175175220026106::CanMakeContext" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@343165112273273213015061264140367175175220026106::CanMakeContext
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename\&.\&.\&. Resources>
concept @343165112273273213015061264140367175175220026106::CanMakeContext = requires(Resources&&\&.\&.\&. resources) {
dependencies::make_context(std::forward<Resources>(resources)\&.\&.\&.);
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

19
docs/man/man3/@343165112273273213015061264140367175175220026106_CanRead.3 Normal file
View File

@@ -0,0 +1,19 @@
.TH "@343165112273273213015061264140367175175220026106::CanRead" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@343165112273273213015061264140367175175220026106::CanRead
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename ContextT, typename KeyT>
concept @343165112273273213015061264140367175175220026106::CanRead = requires(const ContextT& context) { context\&.template get<KeyT>(); }
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

21
docs/man/man3/@343165112273273213015061264140367175175220026106_CanSelect.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "@343165112273273213015061264140367175175220026106::CanSelect" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@343165112273273213015061264140367175175220026106::CanSelect
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename ContextT>
concept @343165112273273213015061264140367175175220026106::CanSelect = requires(ContextT&& context) {
std::forward<ContextT>(context)\&.select(dependencies::Declaration<First>{});
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

21
docs/man/man3/@347145241034102141072004357171274360230346064356_CanMakeStore.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "@347145241034102141072004357171274360230346064356::CanMakeStore" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@347145241034102141072004357171274360230346064356::CanMakeStore
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename\&.\&.\&. EntryTs>
concept @347145241034102141072004357171274360230346064356::CanMakeStore = requires(EntryTs&&\&.\&.\&. entries) {
dependencies::make_computation_store(std::forward<EntryTs>(entries)\&.\&.\&.);
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

21
docs/man/man3/@347145241034102141072004357171274360230346064356_CanOwn.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "@347145241034102141072004357171274360230346064356::CanOwn" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@347145241034102141072004357171274360230346064356::CanOwn
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename ValueT>
concept @347145241034102141072004357171274360230346064356::CanOwn = requires(ValueT&& value) {
dependencies::own_computation<First>(std::forward<ValueT>(value));
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

21
docs/man/man3/@347145241034102141072004357171274360230346064356_CanRead.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "@347145241034102141072004357171274360230346064356::CanRead" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@347145241034102141072004357171274360230346064356::CanRead
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename StoreT, typename KeyT>
concept @347145241034102141072004357171274360230346064356::CanRead = requires(StoreT&& store) {
std::forward<StoreT>(store)\&.template get<KeyT>();
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

21
docs/man/man3/@347145241034102141072004357171274360230346064356_CanReadEntry.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "@347145241034102141072004357171274360230346064356::CanReadEntry" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@347145241034102141072004357171274360230346064356::CanReadEntry
.SH SYNOPSIS
.br
.PP
.SH "Concept definition"
.PP
.nf
template<typename EntryT>
concept @347145241034102141072004357171274360230346064356::CanReadEntry = requires(EntryT&& entry) {
std::forward<EntryT>(entry)\&.get();
}
.PP
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

11
docs/man/man3/COMPONENTS.md.3 Normal file
View File

@@ -0,0 +1,11 @@
.TH "src/include/serif/utils/serialize/COMPONENTS.md" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/utils/serialize/COMPONENTS.md
.SH SYNOPSIS
.br
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

11
docs/man/man3/README.md.3 Normal file
View File

@@ -0,0 +1,11 @@
.TH "src/include/serif/utils/serialize/README.md" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/utils/serialize/README.md
.SH SYNOPSIS
.br
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.

15
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_docs_.3 Normal file
View File

@@ -0,0 +1,15 @@
.TH "docs Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
docs Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBstatic\fP"
.br
.in -1c

9
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_docs_static_.3 Normal file
View File

@@ -0,0 +1,9 @@
.TH "docs/static Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
docs/static Directory Reference
.SH SYNOPSIS
.br
.PP

21
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "src Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBcompile_time_checks\fP"
.br
.ti -1c
.RI "directory \fBinclude\fP"
.br
.ti -1c
.RI "directory \fBlib\fP"
.br
.in -1c

15
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_.3 Normal file
View File

@@ -0,0 +1,15 @@
.TH "src/compile_time_checks Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBserif\fP"
.br
.in -1c

46
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_.3 Normal file
View File

@@ -0,0 +1,46 @@
.TH "src/compile_time_checks/serif Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBbackend\fP"
.br
.ti -1c
.RI "directory \fBdimensions\fP"
.br
.ti -1c
.RI "directory \fBdiscretization\fP"
.br
.ti -1c
.RI "directory \fBeos\fP"
.br
.ti -1c
.RI "directory \fBgeometry\fP"
.br
.ti -1c
.RI "directory \fBmodel\fP"
.br
.ti -1c
.RI "directory \fBoperators\fP"
.br
.ti -1c
.RI "directory \fBsolver\fP"
.br
.ti -1c
.RI "directory \fButils\fP"
.br
.in -1c
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBbackend_independent\&.cpp\fP"
.br
.in -1c

15
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_backend_.3 Normal file
View File

@@ -0,0 +1,15 @@
.TH "src/compile_time_checks/serif/backend Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/backend Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBmfem\fP"
.br
.in -1c

15
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_backend_mfem_.3 Normal file
View File

@@ -0,0 +1,15 @@
.TH "src/compile_time_checks/serif/backend/mfem Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/backend/mfem Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBdiscretization\fP"
.br
.in -1c

15
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_backend_mfem_discretization_.3 Normal file
View File

@@ -0,0 +1,15 @@
.TH "src/compile_time_checks/serif/backend/mfem/discretization Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/backend/mfem/discretization Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBquadrature\fP"
.br
.in -1c

18
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_backend_mfem_discretization_quadrature_.3 Normal file
View File

@@ -0,0 +1,18 @@
.TH "src/compile_time_checks/serif/backend/mfem/discretization/quadrature Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/backend/mfem/discretization/quadrature Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBmfem_resolver\&.cpp\fP"
.br
.ti -1c
.RI "file \fBmfem_static_order\&.cpp\fP"
.br
.in -1c

18
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_dimensions_.3 Normal file
View File

@@ -0,0 +1,18 @@
.TH "src/compile_time_checks/serif/dimensions Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/dimensions Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBcatalogue_meanfield\&.cpp\fP"
.br
.ti -1c
.RI "file \fBquantities\&.cpp\fP"
.br
.in -1c

25
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_discretization_.3 Normal file
View File

@@ -0,0 +1,25 @@
.TH "src/compile_time_checks/serif/discretization Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/discretization Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBblocks\fP"
.br
.ti -1c
.RI "directory \fBforms\fP"
.br
.in -1c
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBfields_meanfield\&.cpp\fP"
.br
.in -1c

15
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_discretization_blocks_.3 Normal file
View File

@@ -0,0 +1,15 @@
.TH "src/compile_time_checks/serif/discretization/blocks Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/discretization/blocks Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBfields\&.cpp\fP"
.br
.in -1c

18
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_discretization_forms_.3 Normal file
View File

@@ -0,0 +1,18 @@
.TH "src/compile_time_checks/serif/discretization/forms Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/discretization/forms Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBforms\&.cpp\fP"
.br
.ti -1c
.RI "file \fBoperands\&.cpp\fP"
.br
.in -1c

15
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_discretization_quadrature_.3 Normal file
View File

@@ -0,0 +1,15 @@
.TH "src/compile_time_checks/serif/discretization/quadrature Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/discretization/quadrature Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBbackend\fP"
.br
.in -1c

15
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_discretization_quadrature_backend_.3 Normal file
View File

@@ -0,0 +1,15 @@
.TH "src/compile_time_checks/serif/discretization/quadrature/backend Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/discretization/quadrature/backend Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBmfem\fP"
.br
.in -1c

18
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_discretization_quadrature_backend_mfem_.3 Normal file
View File

@@ -0,0 +1,18 @@
.TH "src/compile_time_checks/serif/discretization/quadrature/backend/mfem Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/discretization/quadrature/backend/mfem Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBmfem_resolver\&.cpp\fP"
.br
.ti -1c
.RI "file \fBmfem_static_order\&.cpp\fP"
.br
.in -1c

25
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_eos_.3 Normal file
View File

@@ -0,0 +1,25 @@
.TH "src/compile_time_checks/serif/eos Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/eos Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBmodels\fP"
.br
.in -1c
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBconsumers_meanfield\&.cpp\fP"
.br
.ti -1c
.RI "file \fBevaluation\&.cpp\fP"
.br
.in -1c

15
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_eos_models_.3 Normal file
View File

@@ -0,0 +1,15 @@
.TH "src/compile_time_checks/serif/eos/models Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/eos/models Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBtraits\&.cpp\fP"
.br
.in -1c

18
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_eos_runtime_.3 Normal file
View File

@@ -0,0 +1,18 @@
.TH "src/compile_time_checks/serif/eos/runtime Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/eos/runtime Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBdetails\&.cpp\fP"
.br
.ti -1c
.RI "file \fBviews\&.cpp\fP"
.br
.in -1c

27
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_geometry_.3 Normal file
View File

@@ -0,0 +1,27 @@
.TH "src/compile_time_checks/serif/geometry Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/geometry Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBdeformation\&.cpp\fP"
.br
.ti -1c
.RI "file \fBdeformation_meanfield\&.cpp\fP"
.br
.ti -1c
.RI "file \fBsurface\&.cpp\fP"
.br
.ti -1c
.RI "file \fBsurface_boundary\&.cpp\fP"
.br
.ti -1c
.RI "file \fBsurface_storage_meanfield\&.cpp\fP"
.br
.in -1c

39
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_model_.3 Normal file
View File

@@ -0,0 +1,39 @@
.TH "src/compile_time_checks/serif/model Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/model Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBbarotropic_density\&.cpp\fP"
.br
.ti -1c
.RI "file \fBdensity_primal\&.cpp\fP"
.br
.ti -1c
.RI "file \fBdescription\&.cpp\fP"
.br
.ti -1c
.RI "file \fBexecution_validation\&.cpp\fP"
.br
.ti -1c
.RI "file \fBfinite_elements\&.cpp\fP"
.br
.ti -1c
.RI "file \fBnormalization\&.cpp\fP"
.br
.ti -1c
.RI "file \fBscalar_row\&.cpp\fP"
.br
.ti -1c
.RI "file \fBstate\&.cpp\fP"
.br
.ti -1c
.RI "file \fBvalidation\&.cpp\fP"
.br
.in -1c

21
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_operators_.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "src/compile_time_checks/serif/operators Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/operators Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBcomputation_owners\&.cpp\fP"
.br
.ti -1c
.RI "file \fBcoordinate_identity_meanfield\&.cpp\fP"
.br
.ti -1c
.RI "file \fBplan\&.cpp\fP"
.br
.in -1c

28
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_solver_.3 Normal file
View File

@@ -0,0 +1,28 @@
.TH "src/compile_time_checks/serif/solver Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/solver Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBnormalization\fP"
.br
.ti -1c
.RI "directory \fBpreconditioner\fP"
.br
.in -1c
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBcontinuation\&.cpp\fP"
.br
.ti -1c
.RI "file \fBpublic_contracts\&.cpp\fP"
.br
.in -1c

21
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_solver_normalization_.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "src/compile_time_checks/serif/solver/normalization Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/solver/normalization Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBalgebra\&.cpp\fP"
.br
.ti -1c
.RI "file \fBdimensionless\&.cpp\fP"
.br
.ti -1c
.RI "file \fBplan\&.cpp\fP"
.br
.in -1c

21
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_solver_preconditioner_.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH "src/compile_time_checks/serif/solver/preconditioner Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/solver/preconditioner Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBcoupling\&.cpp\fP"
.br
.ti -1c
.RI "file \fBinverses\&.cpp\fP"
.br
.ti -1c
.RI "file \fBlayout\&.cpp\fP"
.br
.in -1c

25
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_utils_.3 Normal file
View File

@@ -0,0 +1,25 @@
.TH "src/compile_time_checks/serif/utils Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/utils Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBdependencies\fP"
.br
.in -1c
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBlaneemden\&.cpp\fP"
.br
.ti -1c
.RI "file \fBprojection\&.cpp\fP"
.br
.in -1c

27
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_compile_time_checks_serif_utils_dependencies_.3 Normal file
View File

@@ -0,0 +1,27 @@
.TH "src/compile_time_checks/serif/utils/dependencies Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/compile_time_checks/serif/utils/dependencies Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBbinding\&.cpp\fP"
.br
.ti -1c
.RI "file \fBcomputation_graph\&.cpp\fP"
.br
.ti -1c
.RI "file \fBdependency_context\&.cpp\fP"
.br
.ti -1c
.RI "file \fBkey_list\&.cpp\fP"
.br
.ti -1c
.RI "file \fBmixed_errors\&.cpp\fP"
.br
.in -1c

15
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_.3 Normal file
View File

@@ -0,0 +1,15 @@
.TH "src/include Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBserif\fP"
.br
.in -1c

58
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_serif_.3 Normal file
View File

@@ -0,0 +1,58 @@
.TH "src/include/serif Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBbackend\fP"
.br
.ti -1c
.RI "directory \fBdimensions\fP"
.br
.ti -1c
.RI "directory \fBdiscretization\fP"
.br
.ti -1c
.RI "directory \fBeos\fP"
.br
.ti -1c
.RI "directory \fBequations\fP"
.br
.ti -1c
.RI "directory \fBgeometry\fP"
.br
.ti -1c
.RI "directory \fBmapping\fP"
.br
.ti -1c
.RI "directory \fBmeta\fP"
.br
.ti -1c
.RI "directory \fBmodel\fP"
.br
.ti -1c
.RI "directory \fBoperators\fP"
.br
.ti -1c
.RI "directory \fBsolver\fP"
.br
.ti -1c
.RI "directory \fButils\fP"
.br
.in -1c
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBruntime\&.hpp\fP"
.br
.ti -1c
.RI "file \fBtypes\&.hpp\fP"
.br
.in -1c

15
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_serif_backend_.3 Normal file
View File

@@ -0,0 +1,15 @@
.TH "src/include/serif/backend Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBmfem\fP"
.br
.in -1c

114
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_serif_backend_mfem_.3 Normal file
View File

@@ -0,0 +1,114 @@
.TH "src/include/serif/backend/mfem Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBdiscretization\fP"
.br
.ti -1c
.RI "directory \fBgeometry\fP"
.br
.ti -1c
.RI "directory \fBmapping\fP"
.br
.ti -1c
.RI "directory \fBmodel\fP"
.br
.ti -1c
.RI "directory \fBoperators\fP"
.br
.ti -1c
.RI "directory \fBprojection\fP"
.br
.ti -1c
.RI "directory \fBserialize\fP"
.br
.ti -1c
.RI "directory \fBshared\fP"
.br
.ti -1c
.RI "directory \fBsolver\fP"
.br
.in -1c
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBruntime\&.hpp\fP"
.br
.ti -1c
.RI "file \fBtypes\&.hpp\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
MFEM implementations live here and in the matching \fRsrc/lib/serif/backend/mfem\fP tree\&. Physics descriptions, equations, EOS relations, normalization rules, Newton acceptance, and continuation scheduling stay in their ordinary SERiF modules\&. The directory migration preserves physics-oriented namespaces; include paths identify the implementation backend\&. Helpers whose responsibility changed now follow their owner: \fRmodel::make_discretization\fP, \fRgeometry::surface::AutomaticPressureSurface\fP, generic preconditioner diagonal regularization, and discretization element coordinates\&.
.PP
Directory Responsibility \fRdiscretization\fP Bind physical terms to MFEM spaces; own coefficient ordering, element orientation, basis evaluation, quadrature, traces, and MFEM mesh extraction\&. \fRmapping\fP Evaluate physical mappings and their variations from supplied reference geometry and current coefficients\&. \fRgeometry\fP Adapt surface and deformation descriptions to MFEM resources, including pressure traces and boundary metrics\&. \fRoperators\fP Integrate equation contributions and expose their linear actions, transposes, diagonals, and assembly\&. No EOS-specific pressure construction belongs here\&. \fRmodel\fP Connect the preceding adapters into the model's computational graph and publish owning evaluated systems\&. The deformation-to-equation bridge belongs here\&. \fRsolver\fP Supply MFEM linear solvers, inverses, geometry admissibility, and stellar adapters to the common Newton and continuation algorithms\&. \fRprojection\fP Project reusable radial profiles into MFEM finite-element spaces\&. \fRshared\fP Small backend facilities with multiple independent consumers: live mesh/space snapshots, boundary traversal, vector spans, and matrix/vector checks\&.
.SH "Ownership and reuse"
.PP
The computational graph owns immutable prepared data, including fixed geometry at equation quadrature points\&. A mapper does not own a second mutable reference-geometry cache\&. Standalone point and face mapping evaluate their own reference geometry directly\&. Accepted systems retain their preparation owners and remain independent of subsequent candidate preparation\&.
.PP
MFEM resources are externally mutable\&. Snapshot policies distinguish topology, material/boundary labels, finite-element layout, and physical/logical coordinate revisions\&. Input factories capture current revisions; reusing stale input metadata is rejected\&. Notify MFEM of direct coordinate changes (for example with \fRNodesUpdated\fP) and rebuild the input context after changing its resources\&. Revision tracking cannot detect unreported writes to external coordinate storage\&.
.PP
A \fRDofMap\fP owns the meaning of reduced coefficients\&. Public coefficient access validates that meaning\&. Internal element traversals obtain a validated \fRElements\fP view once, then retain element bounds, support, and vector-size checks without rescanning all mesh attributes for every element\&. Do not mutate the mesh or space during a traversal\&. Element orientation is implemented once in \fRdiscretization/element_coordinates\fP\&.
.PP
Surface normalization and surface preconditioning share validated boundary traversal, but keep their different integrands: vector radial/harmonic metric diagonals versus scalar H1 mass and stiffness matrices\&. Likewise, model block selection preserves native child assembly and repeated ranges; restriction of an arbitrary preconditioner operator retains its separate unique-index contract\&.
.SH "Core boundary"
.PP
\fRserif_core_lib\fP and \fRserif_core_dep\fP have no MFEM dependency\&. The core header check and the standard-vector Newton tests compile without MFEM include paths\&. The public \fRserif\fP library includes the core and adds this backend\&. Convenience entry headers may select MFEM adapters, while physical configuration and numerical algorithms remain available separately\&.
.PP
Continuation families, physical parameter laws, coordinate stepping, and the driver share \fR\fBserif::solver::continuation\fP\fP in \fRsolver/continuation\fP\&. Its entry header is backend independent; only stellar correction wiring and finite-element state transfer live in \fRbackend/mfem/solver/continuation\fP\&.
.PP
The common Newton loop asks its vector adapter only for owned vectors and coefficient spans\&. The MFEM wrapper supplies linear-solve wiring; it does not duplicate acceptance, backtracking, or checkpoint ownership\&. A future backend should implement its discretization and execution adapters and reuse these common rules, rather than copy the nonlinear or continuation algorithms\&.
.PP
Current term bindings require serial, conforming three-dimensional MFEM spaces\&. Supported value, gradient, divergence, trace, and tensor/dense basis paths retain their explicit compile-time and runtime checks\&. This layout does not imply that every MFEM space or another finite-element library is already supported\&.
.SH "Optional surface density reconstruction"
.PP
Pass the numerical choice directly to the stellar factory, after any deformation:
.PP
.PP
.nf
namespace reconstruction = serif::discretization::reconstruction;
using Density = serif::discretization::blocks::density::mass;
auto finite_elements = serif::model::make_stellar_discretization(
star, mesh_options, moving_boundary,
reconstruction::SurfacePower<Density>{
\&.density_exponent = n,
\&.region = reconstruction::SurfaceAdjacent<
serif::discretization::domain::StellarSurfaceBoundary>{}});
.fi
.PP
.PP
Omitting the argument preserves ordinary interpolation\&. Exponent 1 takes that same path without a reconstruction plan\&. Stored coefficients remain physical nodal densities\&. Only material elements touching the selected boundary change: with inward reference coordinate \fRt=0\fP at the surface and \fRt=1\fP at their inner face, their zero-trace radial space becomes \fRt^n P_(p-1)\fP\&. Tangential interpolation and deeper elements remain ordinary\&. The full basis retains surface degrees of freedom and reproduces constants; the vacuum solve enforces their zero values explicitly\&.
.PP
The plan belongs to the field binding and is immutable throughout a solve\&. Its exponent is an explicit numerical choice; changing an EOS during continuation does not silently change the representation\&. A different profile, mesh or exponent requires a new binding and deliberate field transfer\&. Construction validates matching radial coordinates and the actual hanging-node constraints\&. Tangential/equatorial refinement is supported when those constraints preserve the reconstructed traces\&. Incompatible radial hanging layers fail with a SERiF diagnostic\&.
.PP
\fRdiscretization::backend::mfem::FieldValues<Term>\fP reads the same physical representation as the equation operators\&. Use it for arbitrary-point values, scalar H1 gradients or batches of samples\&. Its binding, coefficients and mesh resources must outlive the reader\&. Extra deformation/compactification maps must be supplied for physical gradients and H(div) values\&. Ordinary MFEM GridFunction interpolation of reconstructed nodal values is not the represented field\&.
.PP
Reference preparation replaces only the radial tensor factors; forward and transpose contractions retain the existing kernels\&. Automatic volume rules include a fractional-power allowance before quadrature-policy resolution, so an explicit fixed order remains authoritative\&. Gaussian quadrature is still approximate and should be checked by increasing its order for a new regime\&. Nonnegativity certifies the polynomial carrier with its positive weight and requires the selected zero-density trace\&. This implementation does not provide a certificate for finite-pressure surface lifting or a general EOS surface profile\&.
.PP
To add a numerical form, provide an ADL-visible \fRmake_reconstruction(specification, binding)\fP overload, a specification with \fRusing Term\fP, and an immutable \fRRadialProfile\fP that evaluates complete nodal functions and inward derivatives, including endpoints\&. The profile must preserve nodal values, constants and compatible face traces\&. Add its admissibility certificate and archive codec explicitly; missing capabilities report errors\&. No MFEM element subclass or physics-equation rewrite is required\&. The current surface-power form supports scalar H1 mass density only\&.
.PP
Weighted archive bindings use schema version 2; older readers reject them rather than reinterpret their coefficients\&. The live Rayfem adapter sends a higher-order sampled display field labeled \fRdensity (sampled)\fP\&. This display approximation is never used by the solver or TOP exporter\&.

75
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_serif_backend_mfem_discretization_.3 Normal file
View File

@@ -0,0 +1,75 @@
.TH "src/include/serif/backend/mfem/discretization Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/discretization Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBquadrature\fP"
.br
.in -1c
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBbasis_evaluation\&.hpp\fP"
.br
.RI "Basis evaluation, pointwise mapping, and transpose application using dense or tensor-product representations\&. "
.ti -1c
.RI "file \fBboundary_faces\&.hpp\fP"
.br
.ti -1c
.RI "file \fBboundary_trace\&.hpp\fP"
.br
.RI "File containing the definition of the restricted dof space for a scalar boundary trace\&. Note in FEM a trace is a restriction on a function to the boundary of a domain\&. Therefore, This file contains the definitions for getting the DOFs at the boundary of a scalar field\&. "
.ti -1c
.RI "file \fBcoefficient_tracking\&.hpp\fP"
.br
.RI "Snapshot and comparison policy for MFEM coefficient views\&. "
.ti -1c
.RI "file \fBdof_map\&.hpp\fP"
.br
.RI "This file contains the \fBDofMap\fP which allows for the full dof vector to be projected into a reduced space of dofs on supported elements for some field Generally, while much of the code here may be exercised, you will rarely see a DofMap be directly invoked\&. Rather, these are generally implicitly constructed through their child class term_binding\&. "
.ti -1c
.RI "file \fBdof_selection\&.hpp\fP"
.br
.RI "This file contains the \fBDofSelection\fP which allows for the selection of a subset of DOFs from a term binding, with boundary attribute information\&. "
.ti -1c
.RI "file \fBelement_coordinates\&.hpp\fP"
.br
.ti -1c
.RI "file \fBfield_values\&.hpp\fP"
.br
.ti -1c
.RI "file \fBmass_diagonal\&.hpp\fP"
.br
.ti -1c
.RI "file \fBreconstruction\&.hpp\fP"
.br
.ti -1c
.RI "file \fBresources\&.hpp\fP"
.br
.ti -1c
.RI "file \fBschema\&.hpp\fP"
.br
.RI "Adapt MFEM meshes to domain schema validation\&. "
.ti -1c
.RI "file \fBtensor_basis\&.hpp\fP"
.br
.RI "Implementation of fast tensor evaluation functions\&. These do not contribute physics but are used to accelerate evaluations\&. "
.ti -1c
.RI "file \fBterm_binding\&.hpp\fP"
.br
.RI "A runtime binding between some term descriptor and its MFEM finite-element space\&. This is used to project down the compile time term descriptors into runtime reinterpretations which can then be used to extract out things like the list of dofs, the element support, and the mesh\&. "
.ti -1c
.RI "file \fBterm_coefficients\&.hpp\fP"
.br
.ti -1c
.RI "file \fBtopology\&.hpp\fP"
.br
.in -1c

32
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_serif_backend_mfem_discretization_quadrature_.3 Normal file
View File

@@ -0,0 +1,32 @@
.TH "src/include/serif/backend/mfem/discretization/quadrature Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/discretization/quadrature Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBconcepts\&.hpp\fP"
.br
.RI "File containing concepts for the quadrature backend module\&. These concepts are used to constrain template parameters in the quadrature backend module\&. "
.ti -1c
.RI "file \fBconfigure\&.hpp\fP"
.br
.RI "File containing utility functions for configuring MFEM integrators with integration rules\&. "
.ti -1c
.RI "file \fBmfem_resolver\&.hpp\fP"
.br
.RI "File containing the MFEMResolver class\&. This class is used to resolve the appropriate MFEM integration rule for a given quadrature context\&. "
.ti -1c
.RI "file \fBmfem_static_order\&.hpp\fP"
.br
.RI "File containing the mfem_form_static_order trait\&. This trait is used to determine the static order of an MFEM integrator for a given form type\&. "
.ti -1c
.RI "file \fBorder\&.hpp\fP"
.br
.RI "File containing the resolve_operand_order function and related utilities\&. These are used to determine the static order of an integrator for a given operand or form type\&. "
.in -1c

18
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_serif_backend_mfem_geometry_.3 Normal file
View File

@@ -0,0 +1,18 @@
.TH "src/include/serif/backend/mfem/geometry Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/geometry Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBdeformation\fP"
.br
.ti -1c
.RI "directory \fBsurface\fP"
.br
.in -1c

44
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_serif_backend_mfem_geometry_deformation_.3 Normal file
View File

@@ -0,0 +1,44 @@
.TH "src/include/serif/backend/mfem/geometry/deformation Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/geometry/deformation Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBdetail\fP"
.br
.in -1c
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBcomputations\&.hpp\fP"
.br
.RI "File containing the factories to make the computation graph for the mfem backend of the geometry/deformation module\&. "
.ti -1c
.RI "file \fBconstrained_radial_extension\&.hpp\fP"
.br
.ti -1c
.RI "file \fBdisplacement_mapping\&.hpp\fP"
.br
.ti -1c
.RI "file \fBgeometry_step\&.hpp\fP"
.br
.ti -1c
.RI "file \fBinputs\&.hpp\fP"
.br
.ti -1c
.RI "file \fBradial_interpolation\&.hpp\fP"
.br
.ti -1c
.RI "file \fBreference_geometry\&.hpp\fP"
.br
.ti -1c
.RI "file \fBsurface_metric\&.hpp\fP"
.br
.in -1c

16
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_serif_backend_mfem_geometry_deformation_detail_.3 Normal file
View File

@@ -0,0 +1,16 @@
.TH "src/include/serif/backend/mfem/geometry/deformation/detail Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/geometry/deformation/detail Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBradial_locator\&.hpp\fP"
.br
.RI "File containing some utility functions for locating points on a radial shell\&. "
.in -1c

30
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_serif_backend_mfem_geometry_surface_.3 Normal file
View File

@@ -0,0 +1,30 @@
.TH "src/include/serif/backend/mfem/geometry/surface Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/geometry/surface Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBboundary_computations\&.hpp\fP"
.br
.ti -1c
.RI "file \fBboundary_data\&.hpp\fP"
.br
.ti -1c
.RI "file \fBboundary_inputs\&.hpp\fP"
.br
.ti -1c
.RI "file \fBboundary_rows\&.hpp\fP"
.br
.ti -1c
.RI "file \fBpressure_boundary\&.hpp\fP"
.br
.ti -1c
.RI "file \fBpressure_field_block\&.hpp\fP"
.br
.in -1c

45
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_serif_backend_mfem_mapping_.3 Normal file
View File

@@ -0,0 +1,45 @@
.TH "src/include/serif/backend/mfem/mapping Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/mapping Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBcompactification\fP"
.br
.in -1c
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBcontext\&.hpp\fP"
.br
.RI "File containing the mapping context structures for volume and face mappings\&. "
.ti -1c
.RI "file \fBdata\&.hpp\fP"
.br
.RI "File containing some misc data structures for the mapping module\&. This was the very first file I ported over from MeanField and I think because of that its organization is actually quite wonky\&. For one its int this poorly named "data" file, which could mean any number of things\&. Regardless, these are basically low leval containers for useful stuff and also some scratch workspaces for mapping operations\&. "
.ti -1c
.RI "file \fBdomain_mapper\&.hpp\fP"
.br
.ti -1c
.RI "file \fBevaluator\&.hpp\fP"
.br
.ti -1c
.RI "file \fBstatus\&.hpp\fP"
.br
.ti -1c
.RI "file \fBtransformations\&.hpp\fP"
.br
.ti -1c
.RI "file \fBvariation\&.hpp\fP"
.br
.ti -1c
.RI "file \fBvolume_cache\&.hpp\fP"
.br
.in -1c

28
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_serif_backend_mfem_mapping_compactification_.3 Normal file
View File

@@ -0,0 +1,28 @@
.TH "src/include/serif/backend/mfem/mapping/compactification Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/mapping/compactification Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBcompactification\&.hpp\fP"
.br
.RI "File containing the definition of the ExteriorDomainMap interface, which is used to define the mapping from reference coordinates to physical coordinates in the exterior domain\&. "
.ti -1c
.RI "file \fBinput_result\&.hpp\fP"
.br
.RI "File containing the input and result structures for the compactification mapping\&. "
.ti -1c
.RI "file \fBkelvin\&.hpp\fP"
.br
.RI "File containing the definition of the KelvinCompactification class, which is a concrete implementation of the ExteriorDomainMap interface for the Kelvin compactification\&. "
.ti -1c
.RI "file \fBvariation\&.hpp\fP"
.br
.RI "File containing the structures for the variation of the compactification mapping\&. "
.in -1c

79
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_serif_backend_mfem_model_.3 Normal file
View File

@@ -0,0 +1,79 @@
.TH "src/include/serif/backend/mfem/model Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/model Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBcomputations\fP"
.br
.ti -1c
.RI "directory \fBnormalization\fP"
.br
.ti -1c
.RI "directory \fBpreconditioning\fP"
.br
.in -1c
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBbinding\&.hpp\fP"
.br
.ti -1c
.RI "file \fBdeformation\&.hpp\fP"
.br
.ti -1c
.RI "file \fBdiscretization\&.hpp\fP"
.br
.ti -1c
.RI "file \fBequilibrium\&.hpp\fP"
.br
.ti -1c
.RI "file \fBequilibrium_evaluator\&.hpp\fP"
.br
.ti -1c
.RI "file \fBfailure\&.hpp\fP"
.br
.ti -1c
.RI "file \fBfinite_elements\&.hpp\fP"
.br
.ti -1c
.RI "file \fBgraph\&.hpp\fP"
.br
.ti -1c
.RI "file \fBinputs\&.hpp\fP"
.br
.ti -1c
.RI "file \fBnormalized_system\&.hpp\fP"
.br
.ti -1c
.RI "file \fBpreconditioned_system\&.hpp\fP"
.br
.ti -1c
.RI "file \fBscalar_row\&.hpp\fP"
.br
.ti -1c
.RI "file \fBstate\&.hpp\fP"
.br
.ti -1c
.RI "file \fBsurface_potential\&.hpp\fP"
.br
.ti -1c
.RI "file \fBsystem\&.hpp\fP"
.br
.ti -1c
.RI "file \fBvolume\&.hpp\fP"
.br
.ti -1c
.RI "file \fBvolume_actions\&.hpp\fP"
.br
.ti -1c
.RI "file \fBvolume_displacement\&.hpp\fP"
.br
.in -1c

36
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_serif_backend_mfem_model_computations_.3 Normal file
View File

@@ -0,0 +1,36 @@
.TH "src/include/serif/backend/mfem/model/computations Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/model/computations Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBinterior\&.hpp\fP"
.br
.ti -1c
.RI "file \fBphysical_blocks\&.hpp\fP"
.br
.ti -1c
.RI "file \fBpotential_infinity\&.hpp\fP"
.br
.ti -1c
.RI "file \fBpressure_boundary\&.hpp\fP"
.br
.ti -1c
.RI "file \fBscalar_row\&.hpp\fP"
.br
.ti -1c
.RI "file \fBshape_derivatives\&.hpp\fP"
.br
.ti -1c
.RI "file \fBsolver_layout\&.hpp\fP"
.br
.ti -1c
.RI "file \fBsurface_potential\&.hpp\fP"
.br
.in -1c

15
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_serif_backend_mfem_model_normalization_.3 Normal file
View File

@@ -0,0 +1,15 @@
.TH "src/include/serif/backend/mfem/model/normalization Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/model/normalization Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBcomputations\&.hpp\fP"
.br
.in -1c

15
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_serif_backend_mfem_model_preconditioning_.3 Normal file
View File

@@ -0,0 +1,15 @@
.TH "src/include/serif/backend/mfem/model/preconditioning Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/model/preconditioning Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBcomputations\&.hpp\fP"
.br
.in -1c

72
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_serif_backend_mfem_operators_.3 Normal file
View File

@@ -0,0 +1,72 @@
.TH "src/include/serif/backend/mfem/operators Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/operators Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBactions\&.hpp\fP"
.br
.ti -1c
.RI "file \fBelement_data\&.hpp\fP"
.br
.ti -1c
.RI "file \fBelement_evaluation\&.hpp\fP"
.br
.ti -1c
.RI "file \fBelement_preparation\&.hpp\fP"
.br
.ti -1c
.RI "file \fBelement_transpose\&.hpp\fP"
.br
.ti -1c
.RI "file \fBgeometry_derivatives\&.hpp\fP"
.br
.ti -1c
.RI "file \fBjacobian_operator\&.hpp\fP"
.br
.ti -1c
.RI "file \fBlinearized_block\&.hpp\fP"
.br
.ti -1c
.RI "file \fBoperand_evaluation\&.hpp\fP"
.br
.ti -1c
.RI "file \fBpreparation\&.hpp\fP"
.br
.ti -1c
.RI "file \fBquadrature\&.hpp\fP"
.br
.ti -1c
.RI "file \fBrejection\&.hpp\fP"
.br
.ti -1c
.RI "file \fBreplaced_rows\&.hpp\fP"
.br
.ti -1c
.RI "file \fBvolume_application\&.hpp\fP"
.br
.ti -1c
.RI "file \fBvolume_computations\&.hpp\fP"
.br
.ti -1c
.RI "file \fBvolume_data\&.hpp\fP"
.br
.ti -1c
.RI "file \fBvolume_field_block\&.hpp\fP"
.br
.ti -1c
.RI "file \fBvolume_inputs\&.hpp\fP"
.br
.ti -1c
.RI "file \fBvolume_stages\&.hpp\fP"
.br
.ti -1c
.RI "file \fBworkspace\&.hpp\fP"
.br
.in -1c

15
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_serif_backend_mfem_projection_.3 Normal file
View File

@@ -0,0 +1,15 @@
.TH "src/include/serif/backend/mfem/projection Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/projection Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBradial\&.hpp\fP"
.br
.in -1c

48
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_serif_backend_mfem_serialize_.3 Normal file
View File

@@ -0,0 +1,48 @@
.TH "src/include/serif/backend/mfem/serialize Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/serialize Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBconfiguration\&.hpp\fP"
.br
.ti -1c
.RI "file \fBdiscretization\&.hpp\fP"
.br
.ti -1c
.RI "file \fBoptions\&.hpp\fP"
.br
.ti -1c
.RI "file \fBresources\&.hpp\fP"
.br
.ti -1c
.RI "file \fBtop\&.hpp\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
\fRsave_discretization(discretization)\fP records the physical and logical reference meshes, finite-element collections and spaces, term support and reduced numbering, compactification coefficients, mapping prescription, and deformation prescription\&. The application's resource owner and computational caches are not persistent data\&.
.PP
\fRrestore_discretization<Original>(node)\fP returns an expected owning discretization\&. \fROriginal\fP supplies its compile-time term, domain-schema and deformation types\&. The returned object has a new resource-owner type; this is why ordinary \fRdecode<Original>\fP cannot reconstruct an arbitrary application-owned discretization\&. Its bindings and reference spaces borrow only resources retained by that new owner\&.
.PP
For a complete \fRmake_discretization(\&.\&.\&.)\fP configuration, include \fRconfiguration\&.hpp\fP and use \fRrestore_configuration<OriginalConfiguration>(node)\fP\&. This restores the resolved physical equations, independent FE resources, normalization choices and preconditioner recipe together\&. The original model's authored callback is replaced by the saved resolved equations; executable callbacks cannot be recreated from data\&.
.PP
For an external mesh, call \fRsave_discretization(discretization, {\&.embed_mesh = false})\fP\&. Supply a \fRMeshResolver\fP to restoration: it receives each requested content fingerprint and returns native MFEM mesh text\&. \fRmesh_text(mesh)\fP produces the canonical text expected by this resolver\&. The same content and reconstruction checks apply to embedded and external meshes\&. Paths are deliberately left to the application\&.
.PP
Mesh text uses the classic locale and \fRmax_digits10\fP\&. Restoration disables MFEM's refinement marking and optional element-orientation repair, then requires the reconstructed native mesh text to match exactly\&. Space reconstruction also checks the native signed element numbering; typed bindings check domain support and reduced numbering\&. Existing geometry validation checks paired reference meshes and shared scalar/displacement companion collections\&.
.PP
The current native format supports finite conforming serial 3D meshes and fixed-order standard H1, L2 and RT spaces\&. Unsupported resource kinds remain explicit \fRunsupported\fP nodes in the archive\&. Exact restoration currently requires the same MFEM version, MFEM exception support and its \fRMFEM_ERROR_THROW\fP error policy, so malformed native input can be reported instead of terminating the application\&. The loader does not change the application's global MFEM error policy\&. Additional dependency versions and MFEM feature configuration are provenance, not reconstructed objects\&. MPI library information is queried only if MPI is already running\&.
.PP
Store physical \fRStellarState\fP coefficients alongside the matching numerical description\&. The caller supplies that pairing; a bare coefficient vector cannot identify its originating mesh\&. State loading validates the compiled coordinate schema, backend loading validates the mesh and FE representation, and Newton resumption additionally checks the rebuilt accepted residual metric\&. Element samples, residuals, Jacobians and preconditioners are recomputed from the loaded inputs\&. A loaded candidate still requires numerical qualification before it can be reported as a converged equilibrium\&.

27
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_serif_backend_mfem_shared_.3 Normal file
View File

@@ -0,0 +1,27 @@
.TH "src/include/serif/backend/mfem/shared Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/shared Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBboundary_elements\&.hpp\fP"
.br
.ti -1c
.RI "file \fBfinite\&.hpp\fP"
.br
.ti -1c
.RI "file \fBinvertible\&.hpp\fP"
.br
.ti -1c
.RI "file \fBparallel\&.hpp\fP"
.br
.ti -1c
.RI "file \fBreference_tracking\&.hpp\fP"
.br
.in -1c

40
docs/man/man3/_Users_tboudreaux_Programming_4DSTAR_MeanField_SERiF_src_include_serif_backend_mfem_solver_.3 Normal file
View File

@@ -0,0 +1,40 @@
.TH "src/include/serif/backend/mfem/solver Directory Reference" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/solver Directory Reference
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBadmissibility\fP"
.br
.ti -1c
.RI "directory \fBcontinuation\fP"
.br
.ti -1c
.RI "directory \fBlinear\fP"
.br
.ti -1c
.RI "directory \fBnonlinear\fP"
.br
.ti -1c
.RI "directory \fBnormalization\fP"
.br
.ti -1c
.RI "directory \fBpreconditioner\fP"
.br
.ti -1c
.RI "directory \fBseed\fP"
.br
.in -1c
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBequilibrium\&.hpp\fP"
.br
.in -1c

Some files were not shown because too many files have changed in this diff Show More