MeanField_SERiF/docs/xml/companion_8hpp.xml

<?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="companion_8hpp" kind="file" language="C++">
    <compoundname>companion.hpp</compoundname>
    <includes local="no">cmath</includes>
    <includes refid="rigid__rotation_8hpp" local="yes">serif/equations/rigid_rotation.hpp</includes>
    <includes refid="errors_8hpp" local="yes">serif/utils/error/errors.hpp</includes>
    <includedby refid="barotropic__density_8hpp" local="yes">src/include/serif/equations/barotropic_density.hpp</includedby>
    <includedby refid="equations_2equations_8hpp" local="yes">src/include/serif/equations/equations.hpp</includedby>
    <includedby refid="equations_2surface__potential_8hpp" local="yes">src/include/serif/equations/surface_potential.hpp</includedby>
    <incdepgraph>
      <node id="12">
        <label>serif/dimensions/dimensions.hpp</label>
        <link refid="dimensions_8hpp"/>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="13" relation="include">
        </childnode>
      </node>
      <node id="13">
        <label>serif/dimensions/quantities.hpp</label>
        <link refid="quantities_8hpp"/>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="14" relation="include">
        </childnode>
        <childnode refid="15" relation="include">
        </childnode>
        <childnode refid="16" relation="include">
        </childnode>
        <childnode refid="17" relation="include">
        </childnode>
        <childnode refid="18" relation="include">
        </childnode>
      </node>
      <node id="19">
        <label>serif/discretization/blocks/base.hpp</label>
        <link refid="base_8hpp"/>
      </node>
      <node id="9">
        <label>serif/discretization/blocks/concepts.hpp</label>
        <link refid="discretization_2blocks_2concepts_8hpp"/>
        <childnode refid="10" relation="include">
        </childnode>
      </node>
      <node id="10">
        <label>serif/discretization/blocks/fields.hpp</label>
        <link refid="fields_8hpp"/>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="12" relation="include">
        </childnode>
        <childnode refid="19" relation="include">
        </childnode>
        <childnode refid="20" relation="include">
        </childnode>
        <childnode refid="25" relation="include">
        </childnode>
        <childnode refid="31" relation="include">
        </childnode>
        <childnode refid="32" relation="include">
        </childnode>
        <childnode refid="33" relation="include">
        </childnode>
      </node>
      <node id="8">
        <label>serif/discretization/blocks/traits.hpp</label>
        <link refid="discretization_2blocks_2traits_8hpp"/>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
      </node>
      <node id="25">
        <label>serif/discretization/domain/concepts.hpp</label>
        <link refid="discretization_2domain_2concepts_8hpp"/>
        <childnode refid="26" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="27" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="21" relation="include">
        </childnode>
        <childnode refid="28" relation="include">
        </childnode>
        <childnode refid="29" relation="include">
        </childnode>
        <childnode refid="17" relation="include">
        </childnode>
        <childnode refid="30" relation="include">
        </childnode>
      </node>
      <node id="31">
        <label>serif/discretization/domain/physical_domains.hpp</label>
        <link refid="physical__domains_8hpp"/>
        <childnode refid="29" relation="include">
        </childnode>
        <childnode refid="25" relation="include">
        </childnode>
      </node>
      <node id="29">
        <label>serif/discretization/domain/types.hpp</label>
        <link refid="discretization_2domain_2types_8hpp"/>
        <childnode refid="11" relation="include">
        </childnode>
      </node>
      <node id="35">
        <label>serif/discretization/forms/operands.hpp</label>
        <link refid="operands_8hpp"/>
        <childnode refid="15" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
      </node>
      <node id="5">
        <label>serif/discretization/forms/value.hpp</label>
        <link refid="value_8hpp"/>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="35" relation="include">
        </childnode>
      </node>
      <node id="20">
        <label>serif/discretization/functional_space/space.hpp</label>
        <link refid="space_8hpp"/>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="21" relation="include">
        </childnode>
        <childnode refid="22" relation="include">
        </childnode>
      </node>
      <node id="1">
        <label>src/include/serif/equations/companion.hpp</label>
        <link refid="companion_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="36" relation="include">
        </childnode>
      </node>
      <node id="3">
        <label>serif/equations/rigid_rotation.hpp</label>
        <link refid="rigid__rotation_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="36" relation="include">
        </childnode>
      </node>
      <node id="22">
        <label>serif/meta/enums.hpp</label>
        <link refid="enums_8hpp"/>
        <childnode refid="23" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="24" relation="include">
        </childnode>
      </node>
      <node id="33">
        <label>serif/meta/names.hpp</label>
        <link refid="names_8hpp"/>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="34" relation="include">
        </childnode>
      </node>
      <node id="48">
        <label>serif/utils/error/codes.hpp</label>
        <link refid="codes_8hpp"/>
        <childnode refid="39" relation="include">
        </childnode>
        <childnode refid="22" relation="include">
        </childnode>
      </node>
      <node id="36">
        <label>serif/utils/error/errors.hpp</label>
        <link refid="errors_8hpp"/>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="21" relation="include">
        </childnode>
        <childnode refid="37" relation="include">
        </childnode>
        <childnode refid="38" 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="46" relation="include">
        </childnode>
        <childnode refid="48" relation="include">
        </childnode>
        <childnode refid="49" relation="include">
        </childnode>
      </node>
      <node id="46">
        <label>serif/utils/misc/concepts/exceptions.hpp</label>
        <link refid="utils_2misc_2concepts_2exceptions_8hpp"/>
        <childnode refid="47" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="18" relation="include">
        </childnode>
      </node>
      <node id="18">
        <label>serif/utils/misc/concepts/numeric.hpp</label>
        <link refid="numeric_8hpp"/>
        <childnode refid="15" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
      </node>
      <node id="17">
        <label>serif/utils/misc/std_helper/cleaning.hpp</label>
        <link refid="cleaning_8hpp"/>
        <childnode refid="7" relation="include">
        </childnode>
      </node>
      <node id="30">
        <label>serif/utils/misc/std_helper/variadic_cleaning.hpp</label>
        <link refid="variadic__cleaning_8hpp"/>
        <childnode refid="26" relation="include">
        </childnode>
      </node>
      <node id="42">
        <label>serif/utils/misc/terminal/colors.hpp</label>
        <link refid="colors_8hpp"/>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="37" relation="include">
        </childnode>
        <childnode refid="43" relation="include">
        </childnode>
        <childnode refid="44" relation="include">
        </childnode>
        <childnode refid="45" relation="include">
        </childnode>
      </node>
      <node id="49">
        <label>serif/utils/types/strings.hpp</label>
        <link refid="types_2strings_8hpp"/>
        <childnode refid="40" relation="include">
        </childnode>
        <childnode refid="50" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
      </node>
      <node id="32">
        <label>serif/utils/types/type_list.hpp</label>
        <link refid="type__list_8hpp"/>
      </node>
      <node id="40">
        <label>algorithm</label>
      </node>
      <node id="6">
        <label>array</label>
      </node>
      <node id="2">
        <label>cmath</label>
      </node>
      <node id="14">
        <label>compare</label>
      </node>
      <node id="15">
        <label>concepts</label>
      </node>
      <node id="26">
        <label>cstddef</label>
      </node>
      <node id="39">
        <label>cstdint</label>
      </node>
      <node id="37">
        <label>cstdio</label>
      </node>
      <node id="43">
        <label>cstdlib</label>
      </node>
      <node id="47">
        <label>exception</label>
      </node>
      <node id="21">
        <label>format</label>
      </node>
      <node id="50">
        <label>iostream</label>
      </node>
      <node id="24">
        <label>magic_enum/magic_enum_all.hpp</label>
      </node>
      <node id="34">
        <label>nameof.hpp</label>
      </node>
      <node id="28">
        <label>numeric</label>
      </node>
      <node id="27">
        <label>span</label>
      </node>
      <node id="4">
        <label>stdexcept</label>
      </node>
      <node id="38">
        <label>string</label>
      </node>
      <node id="11">
        <label>string_view</label>
      </node>
      <node id="16">
        <label>tuple</label>
      </node>
      <node id="7">
        <label>type_traits</label>
      </node>
      <node id="45">
        <label>unistd.h</label>
      </node>
      <node id="23">
        <label>unordered_map</label>
      </node>
      <node id="44">
        <label>utility</label>
      </node>
      <node id="41">
        <label>version</label>
      </node>
    </incdepgraph>
    <invincdepgraph>
      <node id="21">
        <label>src/compile_time_checks/serif/backend_independent.cpp</label>
        <link refid="backend__independent_8cpp"/>
      </node>
      <node id="3">
        <label>src/compile_time_checks/serif/model/barotropic_density.cpp</label>
        <link refid="barotropic__density_8cpp"/>
      </node>
      <node id="4">
        <label>src/compile_time_checks/serif/model/density_primal.cpp</label>
        <link refid="density__primal_8cpp"/>
      </node>
      <node id="5">
        <label>src/compile_time_checks/serif/model/execution_validation.cpp</label>
        <link refid="execution__validation_8cpp"/>
      </node>
      <node id="42">
        <label>src/compile_time_checks/serif/model/finite_elements.cpp</label>
        <link refid="compile__time__checks_2serif_2model_2finite__elements_8cpp"/>
      </node>
      <node id="6">
        <label>src/compile_time_checks/serif/model/normalization.cpp</label>
        <link refid="normalization_8cpp"/>
      </node>
      <node id="27">
        <label>src/compile_time_checks/serif/model/state.cpp</label>
        <link refid="state_8cpp"/>
      </node>
      <node id="7">
        <label>src/compile_time_checks/serif/model/validation.cpp</label>
        <link refid="compile__time__checks_2serif_2model_2validation_8cpp"/>
      </node>
      <node id="8">
        <label>src/compile_time_checks/serif/operators/coordinate_identity_meanfield.cpp</label>
        <link refid="coordinate__identity__meanfield_8cpp"/>
      </node>
      <node id="9">
        <label>src/compile_time_checks/serif/operators/plan.cpp</label>
        <link refid="operators_2plan_8cpp"/>
      </node>
      <node id="36">
        <label>src/include/serif/backend/mfem/model/binding.hpp</label>
        <link refid="backend_2mfem_2model_2binding_8hpp"/>
        <childnode refid="37" relation="include">
        </childnode>
        <childnode refid="38" relation="include">
        </childnode>
      </node>
      <node id="24">
        <label>src/include/serif/backend/mfem/model/computations/surface_potential.hpp</label>
        <link refid="backend_2mfem_2model_2computations_2surface__potential_8hpp"/>
        <childnode refid="25" relation="include">
        </childnode>
      </node>
      <node id="26">
        <label>src/include/serif/backend/mfem/model/equilibrium.hpp</label>
        <link refid="backend_2mfem_2model_2equilibrium_8hpp"/>
        <childnode refid="27" relation="include">
        </childnode>
        <childnode refid="28" relation="include">
        </childnode>
      </node>
      <node id="37">
        <label>src/include/serif/backend/mfem/model/equilibrium_evaluator.hpp</label>
        <link refid="equilibrium__evaluator_8hpp"/>
        <childnode refid="26" relation="include">
        </childnode>
      </node>
      <node id="40">
        <label>src/include/serif/backend/mfem/model/finite_elements.hpp</label>
        <link refid="backend_2mfem_2model_2finite__elements_8hpp"/>
        <childnode refid="41" relation="include">
        </childnode>
        <childnode refid="43" relation="include">
        </childnode>
      </node>
      <node id="25">
        <label>src/include/serif/backend/mfem/model/graph.hpp</label>
        <link refid="backend_2mfem_2model_2graph_8hpp"/>
        <childnode refid="26" relation="include">
        </childnode>
        <childnode refid="33" relation="include">
        </childnode>
      </node>
      <node id="47">
        <label>src/include/serif/backend/mfem/model/normalization/computations.hpp</label>
        <link refid="backend_2mfem_2model_2normalization_2computations_8hpp"/>
        <childnode refid="26" relation="include">
        </childnode>
      </node>
      <node id="23">
        <label>src/include/serif/backend/mfem/model/surface_potential.hpp</label>
        <link refid="backend_2mfem_2model_2surface__potential_8hpp"/>
        <childnode refid="24" relation="include">
        </childnode>
        <childnode refid="34" relation="include">
        </childnode>
      </node>
      <node id="16">
        <label>src/include/serif/backend/mfem/serialize/configuration.hpp</label>
        <link refid="backend_2mfem_2serialize_2configuration_8hpp"/>
      </node>
      <node id="15">
        <label>src/include/serif/backend/mfem/serialize/discretization.hpp</label>
        <link refid="serialize_2discretization_8hpp"/>
        <childnode refid="16" relation="include">
        </childnode>
      </node>
      <node id="18">
        <label>src/include/serif/backend/mfem/serialize/options.hpp</label>
        <link refid="backend_2mfem_2serialize_2options_8hpp"/>
      </node>
      <node id="10">
        <label>src/include/serif/backend/mfem/serialize/top.hpp</label>
        <link refid="backend_2mfem_2serialize_2top_8hpp"/>
        <childnode refid="11" relation="include">
        </childnode>
      </node>
      <node id="33">
        <label>src/include/serif/backend/mfem/solver/admissibility/geometry.hpp</label>
        <link refid="geometry_8hpp"/>
        <childnode refid="28" relation="include">
        </childnode>
      </node>
      <node id="29">
        <label>src/include/serif/backend/mfem/solver/equilibrium.hpp</label>
        <link refid="backend_2mfem_2solver_2equilibrium_8hpp"/>
        <childnode refid="30" relation="include">
        </childnode>
      </node>
      <node id="28">
        <label>src/include/serif/backend/mfem/solver/nonlinear/stellar_problem.hpp</label>
        <link refid="stellar__problem_8hpp"/>
        <childnode refid="29" relation="include">
        </childnode>
      </node>
      <node id="38">
        <label>src/include/serif/backend/mfem/solver/seed/state.hpp</label>
        <link refid="backend_2mfem_2solver_2seed_2state_8hpp"/>
        <childnode refid="39" relation="include">
        </childnode>
      </node>
      <node id="2">
        <label>src/include/serif/equations/barotropic_density.hpp</label>
        <link refid="barotropic__density_8hpp"/>
        <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="7" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="10" relation="include">
        </childnode>
        <childnode refid="12" relation="include">
        </childnode>
      </node>
      <node id="1">
        <label>src/include/serif/equations/companion.hpp</label>
        <link refid="companion_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="12" relation="include">
        </childnode>
        <childnode refid="22" relation="include">
        </childnode>
      </node>
      <node id="12">
        <label>src/include/serif/equations/equations.hpp</label>
        <link refid="equations_2equations_8hpp"/>
        <childnode refid="13" relation="include">
        </childnode>
      </node>
      <node id="22">
        <label>src/include/serif/equations/surface_potential.hpp</label>
        <link refid="equations_2surface__potential_8hpp"/>
        <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="23" relation="include">
        </childnode>
        <childnode refid="12" relation="include">
        </childnode>
        <childnode refid="35" relation="include">
        </childnode>
      </node>
      <node id="35">
        <label>src/include/serif/model/equilibrium_plan.hpp</label>
        <link refid="equilibrium__plan_8hpp"/>
        <childnode refid="36" relation="include">
        </childnode>
        <childnode refid="40" relation="include">
        </childnode>
        <childnode refid="25" relation="include">
        </childnode>
        <childnode refid="44" relation="include">
        </childnode>
        <childnode refid="45" relation="include">
        </childnode>
        <childnode refid="46" relation="include">
        </childnode>
      </node>
      <node id="44">
        <label>src/include/serif/model/execution_validation.hpp</label>
        <link refid="execution__validation_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="26" relation="include">
        </childnode>
      </node>
      <node id="41">
        <label>src/include/serif/model/finite_elements.hpp</label>
        <link refid="model_2finite__elements_8hpp"/>
        <childnode refid="42" relation="include">
        </childnode>
        <childnode refid="30" relation="include">
        </childnode>
      </node>
      <node id="45">
        <label>src/include/serif/model/model.hpp</label>
        <link refid="model_2model_8hpp"/>
        <childnode refid="21" relation="include">
        </childnode>
      </node>
      <node id="46">
        <label>src/include/serif/model/normalization/plan.hpp</label>
        <link refid="model_2normalization_2plan_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="47" relation="include">
        </childnode>
        <childnode refid="17" relation="include">
        </childnode>
      </node>
      <node id="31">
        <label>src/include/serif/solver/continuation/equilibrium.hpp</label>
        <link refid="solver_2continuation_2equilibrium_8hpp"/>
        <childnode refid="32" relation="include">
        </childnode>
      </node>
      <node id="30">
        <label>src/include/serif/solver/equilibrium.hpp</label>
        <link refid="solver_2equilibrium_8hpp"/>
        <childnode refid="31" relation="include">
        </childnode>
        <childnode refid="32" relation="include">
        </childnode>
      </node>
      <node id="39">
        <label>src/include/serif/solver/seed/state.hpp</label>
        <link refid="solver_2seed_2state_8hpp"/>
        <childnode refid="32" relation="include">
        </childnode>
      </node>
      <node id="32">
        <label>src/include/serif/solver/solver.hpp</label>
        <link refid="solver_2solver_8hpp"/>
      </node>
      <node id="13">
        <label>src/include/serif/utils/serialize/equations.hpp</label>
        <link refid="utils_2serialize_2equations_8hpp"/>
        <childnode refid="14" relation="include">
        </childnode>
      </node>
      <node id="14">
        <label>src/include/serif/utils/serialize/model.hpp</label>
        <link refid="utils_2serialize_2model_8hpp"/>
        <childnode refid="15" relation="include">
        </childnode>
        <childnode refid="17" relation="include">
        </childnode>
        <childnode refid="19" relation="include">
        </childnode>
      </node>
      <node id="17">
        <label>src/include/serif/utils/serialize/numerics.hpp</label>
        <link refid="numerics_8hpp"/>
        <childnode refid="16" relation="include">
        </childnode>
        <childnode refid="18" relation="include">
        </childnode>
        <childnode refid="19" relation="include">
        </childnode>
      </node>
      <node id="20">
        <label>src/include/serif/utils/serialize/serialize.hpp</label>
        <link refid="serialize_8hpp"/>
        <childnode refid="21" relation="include">
        </childnode>
      </node>
      <node id="19">
        <label>src/include/serif/utils/serialize/solver.hpp</label>
        <link refid="utils_2serialize_2solver_8hpp"/>
        <childnode refid="20" relation="include">
        </childnode>
      </node>
      <node id="43">
        <label>src/lib/serif/backend/mfem/model/finite_elements.cpp</label>
        <link refid="lib_2serif_2backend_2mfem_2model_2finite__elements_8cpp"/>
      </node>
      <node id="34">
        <label>src/lib/serif/backend/mfem/model/surface_potential.cpp</label>
        <link refid="surface__potential_8cpp"/>
      </node>
      <node id="11">
        <label>src/lib/serif/backend/mfem/serialize/top.cpp</label>
        <link refid="backend_2mfem_2serialize_2top_8cpp"/>
      </node>
    </invincdepgraph>
    <innerclass refid="classserif_1_1equations_1_1_point_mass_companion" prot="public">serif::equations::PointMassCompanion</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;cmath&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><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="6"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="errors_8hpp" kindref="compound">serif/utils/error/errors.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="7"><highlight class="normal"></highlight></codeline>
<codeline lineno="8"><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="12" refid="classserif_1_1equations_1_1_point_mass_companion" 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_point_mass_companion_1a66e1972ad53b3525fe198df5976b7318" kindref="member">PointMassCompanion</ref><sp/>final<sp/>{</highlight></codeline>
<codeline lineno="13"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">public</highlight><highlight class="normal">:</highlight></codeline>
<codeline lineno="14"><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_point_mass_companion_1ab0dd6a89a695b177e2e0c98d839f9f86" kindref="member">Vector</ref><sp/>=<sp/><ref refid="classserif_1_1equations_1_1_rigid_rotation_1a1e11c2a12ffc17fd826e02ec5ac19311" kindref="member">RigidRotation::Vector</ref>;</highlight></codeline>
<codeline lineno="15"><highlight class="normal"></highlight></codeline>
<codeline lineno="17"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1a66e1972ad53b3525fe198df5976b7318" kindref="member">PointMassCompanion</ref>(</highlight></codeline>
<codeline lineno="18"><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/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1affc78341902811a56074fdda98a5f455" kindref="member">gravitational_mass</ref>,</highlight></codeline>
<codeline lineno="19"><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_point_mass_companion_1ab0dd6a89a695b177e2e0c98d839f9f86" kindref="member">Vector</ref>&amp;<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1a8b09c8d9901254422d18950444f38279" kindref="member">position</ref>,</highlight></codeline>
<codeline lineno="20"><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">bool</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1ab0ed34fa200ca8902aca7bf7ab242ab5" kindref="member">tidal_only</ref><sp/>=<sp/></highlight><highlight class="keyword">false</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="21"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>)<sp/>:</highlight></codeline>
<codeline lineno="22"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1a7d80538b8fec3d2dd5c4ab316d6d4561" kindref="member">m_gravitational_mass</ref>(<ref refid="classserif_1_1equations_1_1_point_mass_companion_1affc78341902811a56074fdda98a5f455" kindref="member">gravitational_mass</ref>),</highlight></codeline>
<codeline lineno="23"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1afa5aa4a05fdfd451c6488c2d14a38463" kindref="member">m_position</ref>(<ref refid="classserif_1_1equations_1_1_point_mass_companion_1a8b09c8d9901254422d18950444f38279" kindref="member">position</ref>),</highlight></codeline>
<codeline lineno="24"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1a72e4f7414ee010b1d9021923e863eceb" kindref="member">m_tidal_only</ref>(<ref refid="classserif_1_1equations_1_1_point_mass_companion_1ab0ed34fa200ca8902aca7bf7ab242ab5" kindref="member">tidal_only</ref>)<sp/>{</highlight></codeline>
<codeline lineno="25"><highlight class="normal"></highlight></codeline>
<codeline lineno="26"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/>namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1utils_1_1errors" kindref="compound">utils::errors</ref>;</highlight></codeline>
<codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>serif_ensure&lt;SERiFErrorCode::INVALID_ARGUMENT,<sp/>std::invalid_argument&gt;(std::isfinite(<ref refid="classserif_1_1equations_1_1_point_mass_companion_1affc78341902811a56074fdda98a5f455" kindref="member">gravitational_mass</ref>)<sp/>&amp;&amp;<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1affc78341902811a56074fdda98a5f455" kindref="member">gravitational_mass</ref><sp/>&gt;<sp/>0.0<sp/>&amp;&amp;</highlight></codeline>
<codeline lineno="28"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::isfinite(<ref refid="classserif_1_1equations_1_1_point_mass_companion_1a8b09c8d9901254422d18950444f38279" kindref="member">position</ref>[0])<sp/>&amp;&amp;<sp/>std::isfinite(<ref refid="classserif_1_1equations_1_1_point_mass_companion_1a8b09c8d9901254422d18950444f38279" kindref="member">position</ref>[1])<sp/>&amp;&amp;<sp/>std::isfinite(<ref refid="classserif_1_1equations_1_1_point_mass_companion_1a8b09c8d9901254422d18950444f38279" kindref="member">position</ref>[2]),</highlight></codeline>
<codeline lineno="29"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="stringliteral">&quot;A<sp/>companion<sp/>requires<sp/>a<sp/>finite<sp/>positive<sp/>mass<sp/>and<sp/>a<sp/>finite<sp/>position.&quot;</highlight><highlight class="normal">);</highlight></codeline>
<codeline lineno="30"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="31"><highlight class="normal"></highlight></codeline>
<codeline lineno="33"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1a5dc7af967da10947fcf401e27c3ea2a2" kindref="member">potential</ref>(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1ab0dd6a89a695b177e2e0c98d839f9f86" kindref="member">Vector</ref>&amp;<sp/>x)</highlight><highlight class="keyword"><sp/>const<sp/></highlight><highlight class="normal">{</highlight></codeline>
<codeline lineno="34"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/>result<sp/>=<sp/>-<ref refid="classserif_1_1equations_1_1_point_mass_companion_1a7d80538b8fec3d2dd5c4ab316d6d4561" kindref="member">m_gravitational_mass</ref><sp/>/<sp/>std::hypot(x[0]<sp/>-<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1afa5aa4a05fdfd451c6488c2d14a38463" kindref="member">m_position</ref>[0],<sp/>x[1]<sp/>-<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1afa5aa4a05fdfd451c6488c2d14a38463" kindref="member">m_position</ref>[1],<sp/>x[2]<sp/>-<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1afa5aa4a05fdfd451c6488c2d14a38463" kindref="member">m_position</ref>[2]);</highlight></codeline>
<codeline lineno="35"><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_point_mass_companion_1a72e4f7414ee010b1d9021923e863eceb" kindref="member">m_tidal_only</ref>)<sp/>{</highlight></codeline>
<codeline lineno="36"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>result<sp/>+=<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1a77ad238f01eb3022ef6d627bffcd6a81" kindref="member">uniform_scale</ref>()<sp/>*<sp/>(x[0]<sp/>*<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1afa5aa4a05fdfd451c6488c2d14a38463" kindref="member">m_position</ref>[0]<sp/>+<sp/>x[1]<sp/>*<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1afa5aa4a05fdfd451c6488c2d14a38463" kindref="member">m_position</ref>[1]<sp/>+<sp/>x[2]<sp/>*<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1afa5aa4a05fdfd451c6488c2d14a38463" kindref="member">m_position</ref>[2]);</highlight></codeline>
<codeline lineno="37"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="38"><highlight class="normal"></highlight></codeline>
<codeline lineno="39"><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="40"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="41"><highlight class="normal"></highlight></codeline>
<codeline lineno="43"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1ab0dd6a89a695b177e2e0c98d839f9f86" kindref="member">Vector</ref><sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1a39bf068271012573341c7b7cde96cf31" kindref="member">potential_gradient</ref>(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1ab0dd6a89a695b177e2e0c98d839f9f86" kindref="member">Vector</ref>&amp;<sp/>x)</highlight><highlight class="keyword"><sp/>const<sp/></highlight><highlight class="normal">{</highlight></codeline>
<codeline lineno="44"><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/>distance<sp/>=<sp/>std::hypot(x[0]<sp/>-<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1afa5aa4a05fdfd451c6488c2d14a38463" kindref="member">m_position</ref>[0],<sp/>x[1]<sp/>-<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1afa5aa4a05fdfd451c6488c2d14a38463" kindref="member">m_position</ref>[1],<sp/>x[2]<sp/>-<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1afa5aa4a05fdfd451c6488c2d14a38463" kindref="member">m_position</ref>[2]);</highlight></codeline>
<codeline lineno="45"><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/>scale<sp/>=<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1a7d80538b8fec3d2dd5c4ab316d6d4561" kindref="member">m_gravitational_mass</ref><sp/>/<sp/>(distance<sp/>*<sp/>distance<sp/>*<sp/>distance);</highlight></codeline>
<codeline lineno="46"><highlight class="normal"></highlight></codeline>
<codeline lineno="47"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1ab0dd6a89a695b177e2e0c98d839f9f86" kindref="member">Vector</ref><sp/>result{scale<sp/>*<sp/>(x[0]<sp/>-<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1afa5aa4a05fdfd451c6488c2d14a38463" kindref="member">m_position</ref>[0]),<sp/>scale<sp/>*<sp/>(x[1]<sp/>-<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1afa5aa4a05fdfd451c6488c2d14a38463" kindref="member">m_position</ref>[1]),<sp/>scale<sp/>*<sp/>(x[2]<sp/>-<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1afa5aa4a05fdfd451c6488c2d14a38463" kindref="member">m_position</ref>[2])};</highlight></codeline>
<codeline lineno="48"><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_point_mass_companion_1a72e4f7414ee010b1d9021923e863eceb" kindref="member">m_tidal_only</ref>)<sp/>{</highlight></codeline>
<codeline lineno="49"><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[axis]<sp/>+=<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1a77ad238f01eb3022ef6d627bffcd6a81" kindref="member">uniform_scale</ref>()<sp/>*<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1afa5aa4a05fdfd451c6488c2d14a38463" kindref="member">m_position</ref>[axis];<sp/>}</highlight></codeline>
<codeline lineno="50"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="51"><highlight class="normal"></highlight></codeline>
<codeline lineno="52"><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="53"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="54"><highlight class="normal"></highlight></codeline>
<codeline lineno="56"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1affc78341902811a56074fdda98a5f455" kindref="member">gravitational_mass</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_point_mass_companion_1a7d80538b8fec3d2dd5c4ab316d6d4561" kindref="member">m_gravitational_mass</ref>;<sp/>}</highlight></codeline>
<codeline lineno="58"><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_point_mass_companion_1ab0dd6a89a695b177e2e0c98d839f9f86" kindref="member">Vector</ref>&amp;<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1a8b09c8d9901254422d18950444f38279" kindref="member">position</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_point_mass_companion_1afa5aa4a05fdfd451c6488c2d14a38463" kindref="member">m_position</ref>;<sp/>}</highlight></codeline>
<codeline lineno="60"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1ab0ed34fa200ca8902aca7bf7ab242ab5" kindref="member">tidal_only</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_point_mass_companion_1a72e4f7414ee010b1d9021923e863eceb" kindref="member">m_tidal_only</ref>;<sp/>}</highlight></codeline>
<codeline lineno="61"><highlight class="normal"></highlight></codeline>
<codeline lineno="62"><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/>[[nodiscard]]<sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1a77ad238f01eb3022ef6d627bffcd6a81" kindref="member">uniform_scale</ref>()</highlight><highlight class="keyword"><sp/>const<sp/></highlight><highlight class="normal">{</highlight></codeline>
<codeline lineno="65"><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/>distance<sp/>=<sp/>std::hypot(<ref refid="classserif_1_1equations_1_1_point_mass_companion_1afa5aa4a05fdfd451c6488c2d14a38463" kindref="member">m_position</ref>[0],<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1afa5aa4a05fdfd451c6488c2d14a38463" kindref="member">m_position</ref>[1],<sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1afa5aa4a05fdfd451c6488c2d14a38463" kindref="member">m_position</ref>[2]);</highlight></codeline>
<codeline lineno="66"><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/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1a7d80538b8fec3d2dd5c4ab316d6d4561" kindref="member">m_gravitational_mass</ref><sp/>/<sp/>(distance<sp/>*<sp/>distance<sp/>*<sp/>distance);</highlight></codeline>
<codeline lineno="67"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="68"><highlight class="normal"></highlight></codeline>
<codeline lineno="69"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1a7d80538b8fec3d2dd5c4ab316d6d4561" kindref="member">m_gravitational_mass</ref>;</highlight></codeline>
<codeline lineno="70"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1ab0dd6a89a695b177e2e0c98d839f9f86" kindref="member">Vector</ref><sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1afa5aa4a05fdfd451c6488c2d14a38463" kindref="member">m_position</ref>;</highlight></codeline>
<codeline lineno="71"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1equations_1_1_point_mass_companion_1a72e4f7414ee010b1d9021923e863eceb" kindref="member">m_tidal_only</ref>;</highlight></codeline>
<codeline lineno="72"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="73"><highlight class="normal">}</highlight></codeline>
    </programlisting>
    <location file="src/include/serif/equations/companion.hpp"/>
  </compounddef>
</doxygen>