Files
MeanField_SERiF/docs/xml/equations_2surface__potential_8hpp.xml

740 lines
44 KiB
XML
Raw Normal View History

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.13.2" xml:lang="en-US">
<compounddef id="equations_2surface__potential_8hpp" kind="file" language="C++">
<compoundname>surface_potential.hpp</compoundname>
<includes local="no">optional</includes>
<includes local="no">string_view</includes>
<includes refid="fields_8hpp" local="yes">serif/discretization/blocks/fields.hpp</includes>
<includes refid="companion_8hpp" local="yes">serif/equations/companion.hpp</includes>
<includes refid="point_8hpp" local="yes">serif/equations/point.hpp</includes>
<includes refid="rigid__rotation_8hpp" local="yes">serif/equations/rigid_rotation.hpp</includes>
<includedby refid="barotropic__density_8cpp" local="yes">src/compile_time_checks/serif/model/barotropic_density.cpp</includedby>
<includedby refid="density__primal_8cpp" local="yes">src/compile_time_checks/serif/model/density_primal.cpp</includedby>
<includedby refid="execution__validation_8cpp" local="yes">src/compile_time_checks/serif/model/execution_validation.cpp</includedby>
<includedby refid="normalization_8cpp" local="yes">src/compile_time_checks/serif/model/normalization.cpp</includedby>
<includedby refid="backend_2mfem_2model_2surface__potential_8hpp" local="yes">src/include/serif/backend/mfem/model/surface_potential.hpp</includedby>
<includedby refid="equations_2equations_8hpp" local="yes">src/include/serif/equations/equations.hpp</includedby>
<includedby refid="equilibrium__plan_8hpp" local="yes">src/include/serif/model/equilibrium_plan.hpp</includedby>
<incdepgraph>
<node id="6">
<label>serif/dimensions/dimensions.hpp</label>
<link refid="dimensions_8hpp"/>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="7" relation="include">
</childnode>
</node>
<node id="7">
<label>serif/dimensions/quantities.hpp</label>
<link refid="quantities_8hpp"/>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="9" relation="include">
</childnode>
<childnode refid="10" relation="include">
</childnode>
<childnode refid="11" relation="include">
</childnode>
<childnode refid="12" relation="include">
</childnode>
<childnode refid="13" relation="include">
</childnode>
</node>
<node id="14">
<label>serif/discretization/blocks/base.hpp</label>
<link refid="base_8hpp"/>
</node>
<node id="36">
<label>serif/discretization/blocks/concepts.hpp</label>
<link refid="discretization_2blocks_2concepts_8hpp"/>
<childnode refid="4" relation="include">
</childnode>
</node>
<node id="4">
<label>serif/discretization/blocks/fields.hpp</label>
<link refid="fields_8hpp"/>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="6" relation="include">
</childnode>
<childnode refid="14" relation="include">
</childnode>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="20" relation="include">
</childnode>
<childnode refid="26" relation="include">
</childnode>
<childnode refid="27" relation="include">
</childnode>
<childnode refid="28" relation="include">
</childnode>
</node>
<node id="35">
<label>serif/discretization/blocks/traits.hpp</label>
<link refid="discretization_2blocks_2traits_8hpp"/>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="36" relation="include">
</childnode>
</node>
<node id="20">
<label>serif/discretization/domain/concepts.hpp</label>
<link refid="discretization_2domain_2concepts_8hpp"/>
<childnode refid="21" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="22" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="16" relation="include">
</childnode>
<childnode refid="23" relation="include">
</childnode>
<childnode refid="24" relation="include">
</childnode>
<childnode refid="12" relation="include">
</childnode>
<childnode refid="25" relation="include">
</childnode>
</node>
<node id="26">
<label>serif/discretization/domain/physical_domains.hpp</label>
<link refid="physical__domains_8hpp"/>
<childnode refid="24" relation="include">
</childnode>
<childnode refid="20" relation="include">
</childnode>
</node>
<node id="24">
<label>serif/discretization/domain/types.hpp</label>
<link refid="discretization_2domain_2types_8hpp"/>
<childnode refid="3" relation="include">
</childnode>
</node>
<node id="37">
<label>serif/discretization/forms/operands.hpp</label>
<link refid="operands_8hpp"/>
<childnode refid="10" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="36" relation="include">
</childnode>
</node>
<node id="34">
<label>serif/discretization/forms/value.hpp</label>
<link refid="value_8hpp"/>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="35" relation="include">
</childnode>
<childnode refid="37" relation="include">
</childnode>
</node>
<node id="15">
<label>serif/discretization/functional_space/space.hpp</label>
<link refid="space_8hpp"/>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="16" relation="include">
</childnode>
<childnode refid="17" relation="include">
</childnode>
</node>
<node id="30">
<label>serif/equations/companion.hpp</label>
<link refid="companion_8hpp"/>
<childnode refid="31" relation="include">
</childnode>
<childnode refid="32" relation="include">
</childnode>
<childnode refid="38" relation="include">
</childnode>
</node>
<node id="53">
<label>serif/equations/point.hpp</label>
<link refid="point_8hpp"/>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="10" relation="include">
</childnode>
<childnode refid="21" relation="include">
</childnode>
<childnode refid="11" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="34" relation="include">
</childnode>
<childnode refid="27" relation="include">
</childnode>
</node>
<node id="32">
<label>serif/equations/rigid_rotation.hpp</label>
<link refid="rigid__rotation_8hpp"/>
<childnode refid="31" relation="include">
</childnode>
<childnode refid="33" relation="include">
</childnode>
<childnode refid="34" relation="include">
</childnode>
<childnode refid="38" relation="include">
</childnode>
</node>
<node id="1">
<label>src/include/serif/equations/surface_potential.hpp</label>
<link refid="equations_2surface__potential_8hpp"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="30" relation="include">
</childnode>
<childnode refid="53" relation="include">
</childnode>
<childnode refid="32" relation="include">
</childnode>
</node>
<node id="17">
<label>serif/meta/enums.hpp</label>
<link refid="enums_8hpp"/>
<childnode refid="18" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="19" relation="include">
</childnode>
</node>
<node id="28">
<label>serif/meta/names.hpp</label>
<link refid="names_8hpp"/>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="29" relation="include">
</childnode>
</node>
<node id="50">
<label>serif/utils/error/codes.hpp</label>
<link refid="codes_8hpp"/>
<childnode refid="41" relation="include">
</childnode>
<childnode refid="17" relation="include">
</childnode>
</node>
<node id="38">
<label>serif/utils/error/errors.hpp</label>
<link refid="errors_8hpp"/>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="16" relation="include">
</childnode>
<childnode refid="39" relation="include">
</childnode>
<childnode refid="40" relation="include">
</childnode>
<childnode refid="41" relation="include">
</childnode>
<childnode refid="42" relation="include">
</childnode>
<childnode refid="43" relation="include">
</childnode>
<childnode refid="44" relation="include">
</childnode>
<childnode refid="48" relation="include">
</childnode>
<childnode refid="50" relation="include">
</childnode>
<childnode refid="51" relation="include">
</childnode>
</node>
<node id="48">
<label>serif/utils/misc/concepts/exceptions.hpp</label>
<link refid="utils_2misc_2concepts_2exceptions_8hpp"/>
<childnode refid="49" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="13" relation="include">
</childnode>
</node>
<node id="13">
<label>serif/utils/misc/concepts/numeric.hpp</label>
<link refid="numeric_8hpp"/>
<childnode refid="10" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
</node>
<node id="12">
<label>serif/utils/misc/std_helper/cleaning.hpp</label>
<link refid="cleaning_8hpp"/>
<childnode refid="8" relation="include">
</childnode>
</node>
<node id="25">
<label>serif/utils/misc/std_helper/variadic_cleaning.hpp</label>
<link refid="variadic__cleaning_8hpp"/>
<childnode refid="21" relation="include">
</childnode>
</node>
<node id="44">
<label>serif/utils/misc/terminal/colors.hpp</label>
<link refid="colors_8hpp"/>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="39" relation="include">
</childnode>
<childnode refid="45" relation="include">
</childnode>
<childnode refid="46" relation="include">
</childnode>
<childnode refid="47" relation="include">
</childnode>
</node>
<node id="51">
<label>serif/utils/types/strings.hpp</label>
<link refid="types_2strings_8hpp"/>
<childnode refid="42" relation="include">
</childnode>
<childnode refid="52" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
</node>
<node id="27">
<label>serif/utils/types/type_list.hpp</label>
<link refid="type__list_8hpp"/>
</node>
<node id="42">
<label>algorithm</label>
</node>
<node id="5">
<label>array</label>
</node>
<node id="31">
<label>cmath</label>
</node>
<node id="9">
<label>compare</label>
</node>
<node id="10">
<label>concepts</label>
</node>
<node id="21">
<label>cstddef</label>
</node>
<node id="41">
<label>cstdint</label>
</node>
<node id="39">
<label>cstdio</label>
</node>
<node id="45">
<label>cstdlib</label>
</node>
<node id="49">
<label>exception</label>
</node>
<node id="16">
<label>format</label>
</node>
<node id="52">
<label>iostream</label>
</node>
<node id="19">
<label>magic_enum/magic_enum_all.hpp</label>
</node>
<node id="29">
<label>nameof.hpp</label>
</node>
<node id="23">
<label>numeric</label>
</node>
<node id="2">
<label>optional</label>
</node>
<node id="22">
<label>span</label>
</node>
<node id="33">
<label>stdexcept</label>
</node>
<node id="40">
<label>string</label>
</node>
<node id="3">
<label>string_view</label>
</node>
<node id="11">
<label>tuple</label>
</node>
<node id="8">
<label>type_traits</label>
</node>
<node id="47">
<label>unistd.h</label>
</node>
<node id="18">
<label>unordered_map</label>
</node>
<node id="46">
<label>utility</label>
</node>
<node id="43">
<label>version</label>
</node>
</incdepgraph>
<invincdepgraph>
<node id="27">
<label>src/compile_time_checks/serif/backend_independent.cpp</label>
<link refid="backend__independent_8cpp"/>
</node>
<node id="2">
<label>src/compile_time_checks/serif/model/barotropic_density.cpp</label>
<link refid="barotropic__density_8cpp"/>
</node>
<node id="3">
<label>src/compile_time_checks/serif/model/density_primal.cpp</label>
<link refid="density__primal_8cpp"/>
</node>
<node id="4">
<label>src/compile_time_checks/serif/model/execution_validation.cpp</label>
<link refid="execution__validation_8cpp"/>
</node>
<node id="35">
<label>src/compile_time_checks/serif/model/finite_elements.cpp</label>
<link refid="compile__time__checks_2serif_2model_2finite__elements_8cpp"/>
</node>
<node id="5">
<label>src/compile_time_checks/serif/model/normalization.cpp</label>
<link refid="normalization_8cpp"/>
</node>
<node id="10">
<label>src/compile_time_checks/serif/model/state.cpp</label>
<link refid="state_8cpp"/>
</node>
<node id="29">
<label>src/include/serif/backend/mfem/model/binding.hpp</label>
<link refid="backend_2mfem_2model_2binding_8hpp"/>
<childnode refid="30" relation="include">
</childnode>
<childnode refid="31" relation="include">
</childnode>
</node>
<node id="7">
<label>src/include/serif/backend/mfem/model/computations/surface_potential.hpp</label>
<link refid="backend_2mfem_2model_2computations_2surface__potential_8hpp"/>
<childnode refid="8" relation="include">
</childnode>
</node>
<node id="9">
<label>src/include/serif/backend/mfem/model/equilibrium.hpp</label>
<link refid="backend_2mfem_2model_2equilibrium_8hpp"/>
<childnode refid="10" relation="include">
</childnode>
<childnode refid="11" relation="include">
</childnode>
</node>
<node id="30">
<label>src/include/serif/backend/mfem/model/equilibrium_evaluator.hpp</label>
<link refid="equilibrium__evaluator_8hpp"/>
<childnode refid="9" relation="include">
</childnode>
</node>
<node id="33">
<label>src/include/serif/backend/mfem/model/finite_elements.hpp</label>
<link refid="backend_2mfem_2model_2finite__elements_8hpp"/>
<childnode refid="34" relation="include">
</childnode>
<childnode refid="36" relation="include">
</childnode>
</node>
<node id="8">
<label>src/include/serif/backend/mfem/model/graph.hpp</label>
<link refid="backend_2mfem_2model_2graph_8hpp"/>
<childnode refid="9" relation="include">
</childnode>
<childnode refid="16" relation="include">
</childnode>
</node>
<node id="40">
<label>src/include/serif/backend/mfem/model/normalization/computations.hpp</label>
<link refid="backend_2mfem_2model_2normalization_2computations_8hpp"/>
<childnode refid="9" relation="include">
</childnode>
</node>
<node id="6">
<label>src/include/serif/backend/mfem/model/surface_potential.hpp</label>
<link refid="backend_2mfem_2model_2surface__potential_8hpp"/>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="17" relation="include">
</childnode>
</node>
<node id="22">
<label>src/include/serif/backend/mfem/serialize/configuration.hpp</label>
<link refid="backend_2mfem_2serialize_2configuration_8hpp"/>
</node>
<node id="21">
<label>src/include/serif/backend/mfem/serialize/discretization.hpp</label>
<link refid="serialize_2discretization_8hpp"/>
<childnode refid="22" relation="include">
</childnode>
</node>
<node id="24">
<label>src/include/serif/backend/mfem/serialize/options.hpp</label>
<link refid="backend_2mfem_2serialize_2options_8hpp"/>
</node>
<node id="16">
<label>src/include/serif/backend/mfem/solver/admissibility/geometry.hpp</label>
<link refid="geometry_8hpp"/>
<childnode refid="11" relation="include">
</childnode>
</node>
<node id="12">
<label>src/include/serif/backend/mfem/solver/equilibrium.hpp</label>
<link refid="backend_2mfem_2solver_2equilibrium_8hpp"/>
<childnode refid="13" relation="include">
</childnode>
</node>
<node id="11">
<label>src/include/serif/backend/mfem/solver/nonlinear/stellar_problem.hpp</label>
<link refid="stellar__problem_8hpp"/>
<childnode refid="12" relation="include">
</childnode>
</node>
<node id="31">
<label>src/include/serif/backend/mfem/solver/seed/state.hpp</label>
<link refid="backend_2mfem_2solver_2seed_2state_8hpp"/>
<childnode refid="32" relation="include">
</childnode>
</node>
<node id="18">
<label>src/include/serif/equations/equations.hpp</label>
<link refid="equations_2equations_8hpp"/>
<childnode refid="19" relation="include">
</childnode>
</node>
<node id="1">
<label>src/include/serif/equations/surface_potential.hpp</label>
<link refid="equations_2surface__potential_8hpp"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="6" relation="include">
</childnode>
<childnode refid="18" relation="include">
</childnode>
<childnode refid="28" relation="include">
</childnode>
</node>
<node id="28">
<label>src/include/serif/model/equilibrium_plan.hpp</label>
<link refid="equilibrium__plan_8hpp"/>
<childnode refid="29" relation="include">
</childnode>
<childnode refid="33" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="37" relation="include">
</childnode>
<childnode refid="38" relation="include">
</childnode>
<childnode refid="39" relation="include">
</childnode>
</node>
<node id="37">
<label>src/include/serif/model/execution_validation.hpp</label>
<link refid="execution__validation_8hpp"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="9" relation="include">
</childnode>
</node>
<node id="34">
<label>src/include/serif/model/finite_elements.hpp</label>
<link refid="model_2finite__elements_8hpp"/>
<childnode refid="35" relation="include">
</childnode>
<childnode refid="13" relation="include">
</childnode>
</node>
<node id="38">
<label>src/include/serif/model/model.hpp</label>
<link refid="model_2model_8hpp"/>
<childnode refid="27" relation="include">
</childnode>
</node>
<node id="39">
<label>src/include/serif/model/normalization/plan.hpp</label>
<link refid="model_2normalization_2plan_8hpp"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="40" relation="include">
</childnode>
<childnode refid="23" relation="include">
</childnode>
</node>
<node id="14">
<label>src/include/serif/solver/continuation/equilibrium.hpp</label>
<link refid="solver_2continuation_2equilibrium_8hpp"/>
<childnode refid="15" relation="include">
</childnode>
</node>
<node id="13">
<label>src/include/serif/solver/equilibrium.hpp</label>
<link refid="solver_2equilibrium_8hpp"/>
<childnode refid="14" relation="include">
</childnode>
<childnode refid="15" relation="include">
</childnode>
</node>
<node id="32">
<label>src/include/serif/solver/seed/state.hpp</label>
<link refid="solver_2seed_2state_8hpp"/>
<childnode refid="15" relation="include">
</childnode>
</node>
<node id="15">
<label>src/include/serif/solver/solver.hpp</label>
<link refid="solver_2solver_8hpp"/>
</node>
<node id="19">
<label>src/include/serif/utils/serialize/equations.hpp</label>
<link refid="utils_2serialize_2equations_8hpp"/>
<childnode refid="20" relation="include">
</childnode>
</node>
<node id="20">
<label>src/include/serif/utils/serialize/model.hpp</label>
<link refid="utils_2serialize_2model_8hpp"/>
<childnode refid="21" relation="include">
</childnode>
<childnode refid="23" relation="include">
</childnode>
<childnode refid="25" relation="include">
</childnode>
</node>
<node id="23">
<label>src/include/serif/utils/serialize/numerics.hpp</label>
<link refid="numerics_8hpp"/>
<childnode refid="22" relation="include">
</childnode>
<childnode refid="24" relation="include">
</childnode>
<childnode refid="25" relation="include">
</childnode>
</node>
<node id="26">
<label>src/include/serif/utils/serialize/serialize.hpp</label>
<link refid="serialize_8hpp"/>
<childnode refid="27" relation="include">
</childnode>
</node>
<node id="25">
<label>src/include/serif/utils/serialize/solver.hpp</label>
<link refid="utils_2serialize_2solver_8hpp"/>
<childnode refid="26" relation="include">
</childnode>
</node>
<node id="36">
<label>src/lib/serif/backend/mfem/model/finite_elements.cpp</label>
<link refid="lib_2serif_2backend_2mfem_2model_2finite__elements_8cpp"/>
</node>
<node id="17">
<label>src/lib/serif/backend/mfem/model/surface_potential.cpp</label>
<link refid="surface__potential_8cpp"/>
</node>
</invincdepgraph>
<innerclass refid="classserif_1_1equations_1_1_surface_potential_balance" prot="public">serif::equations::SurfacePotentialBalance</innerclass>
<innernamespace refid="namespaceserif">serif</innernamespace>
<innernamespace refid="namespaceserif_1_1equations">serif::equations</innernamespace>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<programlisting>
<codeline lineno="1"><highlight class="preprocessor">#pragma<sp/>once</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="2"><highlight class="normal"></highlight></codeline>
<codeline lineno="3"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;optional&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;string_view&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><highlight class="normal"></highlight></codeline>
<codeline lineno="6"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="fields_8hpp" kindref="compound">serif/discretization/blocks/fields.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="7"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="companion_8hpp" kindref="compound">serif/equations/companion.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="8"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="point_8hpp" kindref="compound">serif/equations/point.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="9"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="rigid__rotation_8hpp" kindref="compound">serif/equations/rigid_rotation.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="10"><highlight class="normal"></highlight></codeline>
<codeline lineno="11"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1equations" kindref="compound">serif::equations</ref><sp/>{</highlight></codeline>
<codeline lineno="19" refid="classserif_1_1equations_1_1_surface_potential_balance" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">class<sp/></highlight><highlight class="normal"><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a5f4b617cb40a89f92684a945180f0be9" kindref="member">SurfacePotentialBalance</ref><sp/>final<sp/>{</highlight></codeline>
<codeline lineno="20"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">public</highlight><highlight class="normal">:</highlight></codeline>
<codeline lineno="21"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a9131c30622681e9bd1ff4feae39f9141" kindref="member">Potential</ref><sp/>=<sp/><ref refid="structserif_1_1discretization_1_1blocks_1_1gravity_1_1potential" kindref="compound">discretization::blocks::gravity::potential</ref>;</highlight></codeline>
<codeline lineno="22"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1ab435c3b15c149f4f5a1a46689eb60276" kindref="member">SurfaceLevel</ref><sp/>=<sp/><ref refid="structserif_1_1discretization_1_1blocks_1_1barotropic__constant_1_1mass__normalization" kindref="compound">discretization::blocks::barotropic_constant::mass_normalization</ref>;</highlight></codeline>
<codeline lineno="23"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1ab99db64e66ace26faefb9b036e53bf86" kindref="member">AngularVelocity</ref><sp/>=<sp/><ref refid="structserif_1_1discretization_1_1blocks_1_1rotation_1_1angular__velocity" kindref="compound">discretization::blocks::rotation::angular_velocity</ref>;</highlight></codeline>
<codeline lineno="24"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1aa48f398a372c71d6016c209b84bb3ffb" kindref="member">Operands</ref><sp/>=<sp/><ref refid="structserif_1_1utils_1_1types_1_1_type_list" kindref="compound">utils::types::TypeList&lt;discretization::forms::Operand&lt;Potential&gt;</ref>,</highlight></codeline>
<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="structserif_1_1discretization_1_1forms_1_1_operand" kindref="compound">discretization::forms::Operand&lt;SurfaceLevel&gt;</ref>,<sp/><ref refid="structserif_1_1discretization_1_1forms_1_1_operand" kindref="compound">discretization::forms::Operand&lt;AngularVelocity&gt;</ref>&gt;;</highlight></codeline>
<codeline lineno="26"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a49d7e1913ded1bf011856838ecfc9dd9" kindref="member">ResidualQuantity</ref><sp/>=<sp/><ref refid="structserif_1_1dimensions_1_1_gravitational_potential" kindref="compound">dimensions::GravitationalPotential</ref>;</highlight></codeline>
<codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">constexpr</highlight><highlight class="normal"><sp/>std::string_view<sp/><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1aaf718c82128f6392f2fcc006bbccb450" kindref="member">name</ref><sp/>=<sp/></highlight><highlight class="stringliteral">&quot;surface<sp/>effective<sp/>potential<sp/>balance&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="28"><highlight class="normal"></highlight></codeline>
<codeline lineno="30"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">explicit</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a5f4b617cb40a89f92684a945180f0be9" kindref="member">SurfacePotentialBalance</ref>(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1equations_1_1_rigid_rotation_1a1e11c2a12ffc17fd826e02ec5ac19311" kindref="member">RigidRotation::Vector</ref>&amp;<sp/>axis<sp/>=<sp/>{0.0,<sp/>0.0,<sp/>1.0},</highlight></codeline>
<codeline lineno="31"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1equations_1_1_rigid_rotation_1a1e11c2a12ffc17fd826e02ec5ac19311" kindref="member">RigidRotation::Vector</ref>&amp;<sp/>center<sp/>=<sp/>{},<sp/>std::optional&lt;PointMassCompanion&gt;<sp/><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a189d9d730164461b7e49345130457da1" kindref="member">companion</ref><sp/>=<sp/>std::nullopt)<sp/>:</highlight></codeline>
<codeline lineno="32"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a09c89f1fd1e921c7b2f6a331fb4fea23" kindref="member">m_rotation</ref>(<ref refid="classserif_1_1equations_1_1_rigid_rotation_1a3aace3f5fe0ec7d0714b21862b7ca199" kindref="member">RigidRotation::unit_rotation</ref>(axis,<sp/>center)),<sp/><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a6c9d6e3654c22fd8ee1896c2887b6709" kindref="member">m_companion</ref>(<ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a189d9d730164461b7e49345130457da1" kindref="member">companion</ref>)<sp/>{}</highlight></codeline>
<codeline lineno="33"><highlight class="normal"></highlight></codeline>
<codeline lineno="35"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/><ref refid="structserif_1_1equations_1_1_point_linearization" kindref="compound">PointLinearization&lt;Operands&gt;</ref><sp/><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a267788dde4b0ce68fca14b446b412ca4" kindref="member">evaluate</ref>(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1equations_1_1_equation_point" kindref="compound">EquationPoint&lt;Operands&gt;</ref>&amp;<sp/>point)</highlight><highlight class="keyword"><sp/>const<sp/></highlight><highlight class="normal">{</highlight></codeline>
<codeline lineno="36"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/>omega<sp/>=<sp/>point.<ref refid="structserif_1_1equations_1_1_equation_point_1a9a3734ccf2487dfccfc2613917f7d4e8" kindref="member">fields</ref>.get&lt;<ref refid="classserif_1_1equations_1_1_surface_potential_balance_1ab99db64e66ace26faefb9b036e53bf86" kindref="member">AngularVelocity</ref>&gt;();</highlight></codeline>
<codeline lineno="37"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/>centrifugal<sp/>=<sp/><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a09c89f1fd1e921c7b2f6a331fb4fea23" kindref="member">m_rotation</ref>.centrifugal_potential(point.<ref refid="structserif_1_1equations_1_1_equation_point_1ab6f0241afc0150684f4917a3b6cdce36" kindref="member">position</ref>);</highlight></codeline>
<codeline lineno="38"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="structserif_1_1equations_1_1_point_linearization" kindref="compound">PointLinearization&lt;Operands&gt;</ref><sp/>result;</highlight></codeline>
<codeline lineno="39"><highlight class="normal"></highlight></codeline>
<codeline lineno="40"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>result.<ref refid="structserif_1_1equations_1_1_point_linearization_1a9bc0792fca97f037ddede6adacf0f422" kindref="member">residual</ref><sp/>=<sp/>point.<ref refid="structserif_1_1equations_1_1_equation_point_1a9a3734ccf2487dfccfc2613917f7d4e8" kindref="member">fields</ref>.get&lt;<ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a9131c30622681e9bd1ff4feae39f9141" kindref="member">Potential</ref>&gt;()<sp/>-<sp/>omega<sp/>*<sp/>omega<sp/>*<sp/>centrifugal<sp/>-<sp/>point.<ref refid="structserif_1_1equations_1_1_equation_point_1a9a3734ccf2487dfccfc2613917f7d4e8" kindref="member">fields</ref>.get&lt;<ref refid="classserif_1_1equations_1_1_surface_potential_balance_1ab435c3b15c149f4f5a1a46689eb60276" kindref="member">SurfaceLevel</ref>&gt;();</highlight></codeline>
<codeline lineno="41"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>result.<ref refid="structserif_1_1equations_1_1_point_linearization_1a67c6f514532b7eae1456c4f70d964878" kindref="member">field_derivatives</ref>.get&lt;<ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a9131c30622681e9bd1ff4feae39f9141" kindref="member">Potential</ref>&gt;()<sp/>=<sp/>1.0;</highlight></codeline>
<codeline lineno="42"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>result.<ref refid="structserif_1_1equations_1_1_point_linearization_1a67c6f514532b7eae1456c4f70d964878" kindref="member">field_derivatives</ref>.get&lt;<ref refid="classserif_1_1equations_1_1_surface_potential_balance_1ab435c3b15c149f4f5a1a46689eb60276" kindref="member">SurfaceLevel</ref>&gt;()<sp/>=<sp/>-1.0;</highlight></codeline>
<codeline lineno="43"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>result.<ref refid="structserif_1_1equations_1_1_point_linearization_1a67c6f514532b7eae1456c4f70d964878" kindref="member">field_derivatives</ref>.get&lt;<ref refid="classserif_1_1equations_1_1_surface_potential_balance_1ab99db64e66ace26faefb9b036e53bf86" kindref="member">AngularVelocity</ref>&gt;()<sp/>=<sp/>-2.0<sp/>*<sp/>omega<sp/>*<sp/>centrifugal;</highlight></codeline>
<codeline lineno="44"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>result.<ref refid="structserif_1_1equations_1_1_point_linearization_1aca51342a3b8658954b1dc0c1ff3e8209" kindref="member">position_derivative</ref><sp/>=<sp/><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a09c89f1fd1e921c7b2f6a331fb4fea23" kindref="member">m_rotation</ref>.centrifugal_potential_gradient(point.<ref refid="structserif_1_1equations_1_1_equation_point_1ab6f0241afc0150684f4917a3b6cdce36" kindref="member">position</ref>);</highlight></codeline>
<codeline lineno="45"><highlight class="normal"></highlight></codeline>
<codeline lineno="46"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">for</highlight><highlight class="normal"><sp/>(</highlight><highlight class="keywordtype">double</highlight><highlight class="normal">&amp;<sp/>component<sp/>:<sp/>result.<ref refid="structserif_1_1equations_1_1_point_linearization_1aca51342a3b8658954b1dc0c1ff3e8209" kindref="member">position_derivative</ref>)<sp/>{</highlight></codeline>
<codeline lineno="47"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>component<sp/>*=<sp/>-omega<sp/>*<sp/>omega;</highlight></codeline>
<codeline lineno="48"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="49"><highlight class="normal"></highlight></codeline>
<codeline lineno="50"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(<ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a6c9d6e3654c22fd8ee1896c2887b6709" kindref="member">m_companion</ref>)<sp/>{</highlight></codeline>
<codeline lineno="51"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>result.<ref refid="structserif_1_1equations_1_1_point_linearization_1a9bc0792fca97f037ddede6adacf0f422" kindref="member">residual</ref><sp/>+=<sp/><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a6c9d6e3654c22fd8ee1896c2887b6709" kindref="member">m_companion</ref>-&gt;potential(point.<ref refid="structserif_1_1equations_1_1_equation_point_1ab6f0241afc0150684f4917a3b6cdce36" kindref="member">position</ref>);</highlight></codeline>
<codeline lineno="52"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal"><sp/>gradient<sp/>=<sp/><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a6c9d6e3654c22fd8ee1896c2887b6709" kindref="member">m_companion</ref>-&gt;potential_gradient(point.<ref refid="structserif_1_1equations_1_1_equation_point_1ab6f0241afc0150684f4917a3b6cdce36" kindref="member">position</ref>);</highlight></codeline>
<codeline lineno="53"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">for</highlight><highlight class="normal"><sp/>(</highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>axis<sp/>=<sp/>0;<sp/>axis<sp/>&lt;<sp/>3;<sp/>++axis)<sp/>{<sp/>result.<ref refid="structserif_1_1equations_1_1_point_linearization_1aca51342a3b8658954b1dc0c1ff3e8209" kindref="member">position_derivative</ref>[axis]<sp/>+=<sp/>gradient[axis];<sp/>}</highlight></codeline>
<codeline lineno="54"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="55"><highlight class="normal"></highlight></codeline>
<codeline lineno="56"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>result;</highlight></codeline>
<codeline lineno="57"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="59"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1equations_1_1_rigid_rotation" kindref="compound">RigidRotation</ref>&amp;<sp/><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a89d9b65998dd11393f0e780f95926321" kindref="member">rotation</ref>()<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">noexcept</highlight><highlight class="normal"><sp/>{<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a09c89f1fd1e921c7b2f6a331fb4fea23" kindref="member">m_rotation</ref>;<sp/>}</highlight></codeline>
<codeline lineno="61"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::optional&lt;PointMassCompanion&gt;&amp;<sp/><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a189d9d730164461b7e49345130457da1" kindref="member">companion</ref>()<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">noexcept</highlight><highlight class="normal"><sp/>{<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a6c9d6e3654c22fd8ee1896c2887b6709" kindref="member">m_companion</ref>;<sp/>}</highlight></codeline>
<codeline lineno="62"><highlight class="normal"></highlight></codeline>
<codeline lineno="63"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">private</highlight><highlight class="normal">:</highlight></codeline>
<codeline lineno="64"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classserif_1_1equations_1_1_rigid_rotation" kindref="compound">RigidRotation</ref><sp/><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a09c89f1fd1e921c7b2f6a331fb4fea23" kindref="member">m_rotation</ref>;</highlight></codeline>
<codeline lineno="65"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::optional&lt;PointMassCompanion&gt;<sp/><ref refid="classserif_1_1equations_1_1_surface_potential_balance_1a6c9d6e3654c22fd8ee1896c2887b6709" kindref="member">m_companion</ref>;</highlight></codeline>
<codeline lineno="66"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="67"><highlight class="normal">}</highlight></codeline>
</programlisting>
<location file="src/include/serif/equations/surface_potential.hpp"/>
</compounddef>
</doxygen>