Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
NodeUpdateDerivsVaryingAlphaAVMHD.hpp
Go to the documentation of this file.
1// -------------------------------------------------------//
2//
3// SHAMROCK code for hydrodynamics
4// Copyright (c) 2021-2026 Timothée David--Cléris <tim.shamrock@proton.me>
5// SPDX-License-Identifier: CeCILL Free Software License Agreement v2.1
6// Shamrock is licensed under the CeCILL 2.1 License, see LICENSE for more information
7//
8// -------------------------------------------------------//
9
10#pragma once
11
19
20#include "shambase/string.hpp"
21#include "shambackends/vec.hpp"
27
28#define NODE_EDGES(X_RO, X_RW) \
29 /* scalars */ \
30 X_RO(shamrock::solvergraph::IDataEdge<Tscal>, gpart_mass) \
31 X_RO(shamrock::solvergraph::IDataEdge<Tscal>, alpha_u) \
32 X_RO(shamrock::solvergraph::IDataEdge<Tscal>, beta_AV) \
33 X_RO(shamrock::solvergraph::IDataEdge<Tscal>, mu_0) \
34 \
35 /* counts */ \
36 X_RO(shamrock::solvergraph::Indexes<u32>, part_counts) \
37 X_RO(shamrock::solvergraph::Indexes<u32>, part_counts_with_ghost) \
38 \
39 /* fields */ \
40 X_RO(shamrock::solvergraph::IFieldSpan<Tvec>, xyz) \
41 X_RO(shamrock::solvergraph::IFieldSpan<Tscal>, hpart) \
42 X_RO(shamrock::solvergraph::IFieldSpan<Tvec>, vxyz) \
43 X_RO(shamrock::solvergraph::IFieldSpan<Tscal>, uint) \
44 X_RO(shamrock::solvergraph::IFieldSpan<Tscal>, omega) \
45 X_RO(shamrock::solvergraph::IFieldSpan<Tscal>, pressure) \
46 X_RO(shamrock::solvergraph::IFieldSpan<Tscal>, cs) \
47 X_RO(shamrock::solvergraph::IFieldSpan<Tscal>, alpha_AV) \
48 X_RO(shamrock::solvergraph::IFieldSpan<Tvec>, B_on_rho) \
49 \
50 /* neigh */ \
51 X_RO(shammodels::sph::solvergraph::NeighCache, neigh_cache) \
52 \
53 /* outputs */ \
54 X_RW(shamrock::solvergraph::IFieldSpan<Tvec>, axyz) \
55 X_RW(shamrock::solvergraph::IFieldSpan<Tscal>, duint)
56
58
59 template<class Tvec, template<class> class SPHKernel>
60 class NodeUpdateDerivsVaryingAlphaAVMHD : public shamrock::solvergraph::INode {
61
62 using Tscal = shambase::VecComponent<Tvec>;
63
64 static constexpr Tscal kernel_radius = SPHKernel<Tscal>::Rkern;
65
66 public:
67 NodeUpdateDerivsVaryingAlphaAVMHD() {}
68
69 EXPAND_NODE_EDGES(NODE_EDGES)
70
72
73 inline virtual std::string _impl_get_label() const {
74 return "UpdateDerivsVaryingAlphaAVMHD";
75 };
76
77 inline virtual std::string _impl_get_tex() const {
78 std::string tex = R"tex(
79 Hydro update derivs with varying $\alpha$ artificial viscosity, using the MHD signal
80 velocity (Price et al. 2018, eqs.~34, 35, 40, 42 with $c_s \to v_f$). The pure MHD terms
81 are added separately.
82
83 \begin{align}
84 \rho_a &= {gpart_mass} \left( \frac{h_{\rm fact}}{ {hpart}_a } \right)^3,
85 \quad \mathbf{B}_a = \rho_a {B_on_rho}_a \\
86 v_{f,a} &= \sqrt{ {cs}_a^2 + \frac{\vert \mathbf{B}_a \vert^2}{ {mu_0} \rho_a } } \\
87 \mathbf{v}_{ab} &= {vxyz}_a - {vxyz}_b, \quad
88 \hat{\mathbf{r}}_{ab} = \frac{ {xyz}_a - {xyz}_b }{ \vert {xyz}_a - {xyz}_b \vert },
89 \quad F_{ab}(h) = \frac{\partial W}{\partial r}(\vert {xyz}_a - {xyz}_b \vert, h) \\
90 v_{{\rm sig},a} &= {alpha_AV}_a v_{f,a}
91 + {beta_AV} \vert \mathbf{v}_{ab} \cdot \hat{\mathbf{r}}_{ab} \vert \\
92 q^a_{ab} &= \max\left( -\frac{1}{2} \rho_a v_{{\rm sig},a}
93 \, \mathbf{v}_{ab} \cdot \hat{\mathbf{r}}_{ab}, 0 \right) \\
94 v^u_{\rm sig} &= \sqrt{ \frac{ 2 \vert {pressure}_a - {pressure}_b \vert }{ \rho_a + \rho_b } } \\
95 {axyz}_a &= - {gpart_mass} \sum_b \left[
96 \frac{ {pressure}_a + q^a_{ab} }{ {omega}_a \rho_a^2 } F_{ab}(h_a)
97 + \frac{ {pressure}_b + q^b_{ab} }{ {omega}_b \rho_b^2 } F_{ab}(h_b)
98 \right] \hat{\mathbf{r}}_{ab} \\
99 {duint}_a &= {gpart_mass} \sum_b \left[
100 \frac{ {pressure}_a + q^a_{ab} }{ {omega}_a \rho_a^2 }
101 \, \mathbf{v}_{ab} \cdot \hat{\mathbf{r}}_{ab} \, F_{ab}(h_a)
102 + \frac{1}{2} {alpha_u} \, v^u_{\rm sig} ({uint}_a - {uint}_b)
103 \left( \frac{F_{ab}(h_a)}{ {omega}_a \rho_a } + \frac{F_{ab}(h_b)}{ {omega}_b \rho_b } \right)
104 \right] \\
105 a &\in [0, {part_counts}), \quad h_{\rm fact} = {hfact}
106 \end{align}
107 )tex";
108
109 replace_edges_tex_symbols(tex);
110
111 shambase::replace_all(tex, "{hfact}", sham::format("{}", SPHKernel<Tscal>::hfactd));
112
113 return tex;
114 };
115 };
116} // namespace shammodels::sph::modules
117
118#undef NODE_EDGES
virtual std::string _impl_get_label() const
get the label of the node
Inode is node between data edges, takes multiple inputs, multiple outputs.
Definition INode.hpp:31
void replace_all(std::string &inout, std::string_view what, std::string_view with)
replace all occurence of a search string with another
Definition string.hpp:106
namespace for the sph model modules