Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
NodeBiCGSTABLoop.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
20
22#include "shambackends/vec.hpp"
46#include <memory>
47
48#define NODE_EDGES(X_RO, X_RW) \
49 /* ------------------- inputs ------------------- */ \
50 X_RO(shamrock::solvergraph::Indexes<u32>, sizes) \
51 X_RO(shamrock::solvergraph::Indexes<u32>, sizes_no_gz) \
52 X_RO(CellGraphEdge, cell_neigh_graph) \
53 X_RO(shamrock::solvergraph::IFieldSpan<Tscal>, spans_block_cell_sizes) \
54 X_RO(shamrock::solvergraph::IFieldSpan<Tscal>, spans_rho) \
55 X_RO(shamrock::solvergraph::ScalarEdge<Tscal>, mean_rho) \
56 X_RO(shamrock::solvergraph::DDSharedBuffers<u32>, idx_in_ghost) \
57 X_RO(shamrock::solvergraph::RankGetter, rank_owner) \
58 \
59 /* ------------------- outputs ------------------- */ \
60 X_RW(shamrock::solvergraph::IFieldRefs<Tscal>, spans_phi) \
61 \
62 /* ------------------- work fields ------------------- */ \
63 X_RW(shamrock::solvergraph::Field<Tscal>, spans_phi_res) \
64 X_RW(shamrock::solvergraph::Field<Tscal>, spans_phi_res_bis) \
65 X_RW(shamrock::solvergraph::Field<Tscal>, spans_phi_p) \
66 X_RW(shamrock::solvergraph::Field<Tscal>, spans_phi_Ap) \
67 X_RW(shamrock::solvergraph::Field<Tscal>, spans_phi_s) \
68 X_RW(shamrock::solvergraph::Field<Tscal>, spans_phi_As) \
69 X_RW(shamrock::solvergraph::Field<Tscal>, spans_phi_hadamard_prod) \
70 X_RW(shamrock::solvergraph::IDataEdge<Tscal>, old_values) \
71 X_RW(shamrock::solvergraph::IDataEdge<Tscal>, new_values) \
72 X_RW(shamrock::solvergraph::IDataEdge<Tscal>, e_norm) \
73 X_RW(shamrock::solvergraph::IDataEdge<Tscal>, alpha) \
74 X_RW(shamrock::solvergraph::IDataEdge<Tscal>, beta) \
75 X_RW(shamrock::solvergraph::IDataEdge<Tscal>, w_stab) \
76 X_RW(shamrock::solvergraph::IDataEdge<Tscal>, shadow_res_norm) \
77 X_RW(shamrock::solvergraph::Field<Tscal>, spans_rhs) \
78 X_RW(shamrock::solvergraph::IDataEdge<Tscal>, rhs_norm_value)
79
81
101 template<class Tvec, class TgridVec>
102 class NodeBiCGSTABLoop : public shamrock::solvergraph::INode {
103 using Tscal = shambase::VecComponent<Tvec>;
105
106 u32 block_size;
107 Tscal fourPiG;
108 u32 Niter_max;
109 Tscal tol_cvg;
110 Tscal tol_happy_bk;
111
112 u32 last_iteration_count = 0;
113
115 BiCGSTABInit<Tvec, TgridVec> node_init{block_size, fourPiG};
117 ResidualDot<Tscal> node_ddot_rhs{block_size};
119 ResidualDot<Tscal> node_ddot_rstarj_rstarj{block_size};
121 shamrock::solvergraph::NodeHadamardProd<Tscal> node_had_prod_rj_rp0{block_size};
122 shamrock::solvergraph::NodeSumReduction<Tscal> node_ddot_rj_rp0{block_size};
124 NodeSpMVPoisson3D<Tvec, TgridVec> node_Apj{block_size};
126 shamrock::solvergraph::NodeHadamardProd<Tscal> node_had_Apj_rp0{block_size};
127 shamrock::solvergraph::NodeSumReduction<Tscal> node_ddot_Apj_rp0{block_size};
131 ResidualDot<Tscal> node_ddot_sj_sj{block_size};
133 shamrock::solvergraph::NodeAXPY<Tscal> node_new_phi_happy_break{block_size};
135 NodeSpMVPoisson3D<Tvec, TgridVec> node_Asj{block_size};
137 shamrock::solvergraph::NodeHadamardProd<Tscal> node_had_Asj_sj{block_size};
138 shamrock::solvergraph::NodeSumReduction<Tscal> node_ddot_Asj_sj{block_size};
140 ResidualDot<Tscal> node_ddot_Asj_Asj{block_size};
146 ResidualDot<Tscal> node_ddot_rj_rj{block_size};
148 shamrock::solvergraph::NodeHadamardProd<Tscal> node_had_rjnew_rp0{block_size};
149 shamrock::solvergraph::NodeSumReduction<Tscal> node_ddot_rjnew_rp0{block_size};
153 shamrock::solvergraph::NodeOverwrite<Tscal> node_overwrite_rp0{block_size};
155 shamrock::solvergraph::NodeOverwrite<Tscal> node_overwrite_p{block_size};
156
157 // ghost exchange of p_k, s_k and phi (they share the same temporary ghost edge)
158 std::shared_ptr<shamrock::solvergraph::PatchDataFieldDDShared<Tscal>> p_ghosts
159 = std::make_shared<shamrock::solvergraph::PatchDataFieldDDShared<Tscal>>(
160 "p_ghosts", "p_{\\rm ghosts}");
170
171 public:
172 NodeBiCGSTABLoop(
173 u32 block_size, Tscal fourPiG, u32 Niter_max, Tscal tol_cvg, Tscal tol_happy_bk)
174 : block_size(block_size), fourPiG(fourPiG), Niter_max(Niter_max), tol_cvg(tol_cvg),
175 tol_happy_bk(tol_happy_bk) {}
176
177 // same as EXPAND_NODE_EDGES(NODE_EDGES), with set_edges also wiring the inner nodes
178 struct Edges {
179 NODE_EDGES(INODE_DECL_RO, INODE_DECL_RW)
180 };
181
182 inline void set_edges(
183 NODE_EDGES(INODE_PARAM_RO, INODE_PARAM_RW) SourceLocation loc = SourceLocation{}) {
185
186 __internal_set_ro_edges({NODE_EDGES(INODE_PUSH_RO1, INODE_PUSH_RW1)});
187 __internal_set_rw_edges({NODE_EDGES(INODE_PUSH_RO2, INODE_PUSH_RW2)});
188
189 node_init.set_edges(
190 sizes,
191 cell_neigh_graph,
192 spans_block_cell_sizes,
193 spans_phi,
194 spans_rho,
195 mean_rho,
196 spans_phi_res,
197 spans_phi_res_bis,
198 spans_phi_p,
199 spans_rhs);
200 node_ddot_rhs.set_edges(sizes_no_gz, spans_rhs, rhs_norm_value);
201 node_ddot_rstarj_rstarj.set_edges(sizes_no_gz, spans_phi_res_bis, shadow_res_norm);
202 node_had_prod_rj_rp0.set_edges(
203 sizes, spans_phi_res, spans_phi_res_bis, spans_phi_hadamard_prod);
204 node_ddot_rj_rp0.set_edges(sizes_no_gz, spans_phi_hadamard_prod, old_values);
205 node_Apj.set_edges(
206 sizes, cell_neigh_graph, spans_block_cell_sizes, spans_phi_p, spans_phi_Ap);
207 node_had_Apj_rp0.set_edges(
208 sizes, spans_phi_Ap, spans_phi_res_bis, spans_phi_hadamard_prod);
209 node_ddot_Apj_rp0.set_edges(sizes_no_gz, spans_phi_hadamard_prod, e_norm);
210 // s = e_norm * s + beta * r + alpha * Ap
211 node_sj_vec.set_edges(
212 sizes, spans_phi_res, spans_phi_Ap, e_norm, beta, alpha, spans_phi_s);
213 node_ddot_sj_sj.set_edges(sizes_no_gz, spans_phi_s, e_norm);
214 node_new_phi_happy_break.set_edges(sizes, spans_phi_p, alpha, spans_phi);
215 node_Asj.set_edges(
216 sizes, cell_neigh_graph, spans_block_cell_sizes, spans_phi_s, spans_phi_As);
217 node_had_Asj_sj.set_edges(sizes, spans_phi_As, spans_phi_s, spans_phi_hadamard_prod);
218 node_ddot_Asj_sj.set_edges(sizes_no_gz, spans_phi_hadamard_prod, e_norm);
219 node_ddot_Asj_Asj.set_edges(sizes_no_gz, spans_phi_As, new_values);
220 // phi = phi + alpha * p + w_stab * s
221 node_new_phi.set_edges(sizes, spans_phi_p, spans_phi_s, alpha, w_stab, spans_phi);
222 // r = e_norm * r + new_values * s + w_stab * As
223 node_new_res.set_edges(
224 sizes, spans_phi_s, spans_phi_As, e_norm, new_values, w_stab, spans_phi_res);
225 node_ddot_rj_rj.set_edges(sizes_no_gz, spans_phi_res, e_norm);
226 node_had_rjnew_rp0.set_edges(
227 sizes, spans_phi_res, spans_phi_res_bis, spans_phi_hadamard_prod);
228 node_ddot_rjnew_rp0.set_edges(sizes_no_gz, spans_phi_hadamard_prod, new_values);
229 // p = beta * p + e_norm * r + alpha * Ap
230 node_new_p_vec.set_edges(
231 sizes, spans_phi_res, spans_phi_Ap, beta, e_norm, alpha, spans_phi_p);
232 node_overwrite_rp0.set_edges(sizes, spans_phi_res, spans_phi_res_bis);
233 node_overwrite_p.set_edges(sizes, spans_phi_res, spans_phi_p);
234
235 node_gz_p.set_edges(spans_phi_p, idx_in_ghost, p_ghosts);
236 node_exch_gz_p.set_edges(rank_owner, p_ghosts);
237 node_replace_gz_p.set_edges(p_ghosts, spans_phi_p);
238 node_gz_s.set_edges(spans_phi_s, idx_in_ghost, p_ghosts);
239 node_exch_gz_s.set_edges(rank_owner, p_ghosts);
240 node_replace_gz_s.set_edges(p_ghosts, spans_phi_s);
241 node_gz_phi.set_edges(spans_phi, idx_in_ghost, p_ghosts);
242 node_exch_gz_phi.set_edges(rank_owner, p_ghosts);
243 node_replace_gz_phi.set_edges(p_ghosts, spans_phi);
244 }
245
246 inline Edges get_edges() {
247 int ro = 0;
248 int rw = 0;
249 return Edges{NODE_EDGES(INODE_GET_RO, INODE_GET_RW)};
250 }
251
253 NODE_EDGES(INODE_TEX_DECL, INODE_TEX_DECL),
254 NODE_EDGES(INODE_TEX_GET_RO, INODE_TEX_GET_RW),
255 NODE_EDGES(INODE_TEX_REPLACE, INODE_TEX_REPLACE))
256
257
258 inline u32 get_last_iteration_count() const { return last_iteration_count; }
259
261
262 inline virtual std::string _impl_get_label() const { return "BiCGSTABMainLoop"; };
263
264 virtual std::string _impl_get_tex() const;
265 };
266
267} // namespace shammodels::basegodunov::modules
268
269#undef NODE_EDGES
#define NODE_EDGES(X_RO, X_RW)
declare the list of edges for this node
Initialisation step of the BiCGSTAB Poisson solver.
Defines the DDSharedBuffers class for managing buffers contained in a distributed data shared.
Solver graph node for exchanging ghost field data between distributed processes.
This module allows to extract ghosts for a generic field such as density, velocity,...
Node computing the in place update z <- z + alpha * x + beta * y on fields.
Node computing the in place update y <- y + alpha * x on fields.
Node computing the elementwise (Hadamard) product of two fields.
Node computing the linear combination z <- alpha_0 * z + alpha_1 * x + alpha_2 * y on fields.
Node copying a field into another one (y <- x).
Sparse matrix-vector product , being the 3D Poisson matrix.
Node computing the global sum of a field over all patches and ranks.
Shared distributed data field for patch data management in solver graphs.
This module allows replacing ghost values for a generic field with updated values.
Squared L2 norm of a field, summed over all patches and ranks.
std::uint32_t u32
32 bit unsigned integer
Initialisation step of BiCGSTAB: compute the right-hand side , the residual , the shadow residual an...
virtual std::string _impl_get_tex() const
get the tex of the node
virtual std::string _impl_get_label() const
get the label of the node
INODE_EXPAND_TEX_SYMBOLS(INODE_TEX_DECL(shamrock::solvergraph::Indexes< u32 >, sizes) INODE_TEX_DECL(shamrock::solvergraph::Indexes< u32 >, sizes_no_gz) INODE_TEX_DECL(CellGraphEdge, cell_neigh_graph) INODE_TEX_DECL(shamrock::solvergraph::IFieldSpan< Tscal >, spans_block_cell_sizes) INODE_TEX_DECL(shamrock::solvergraph::IFieldSpan< Tscal >, spans_rho) INODE_TEX_DECL(shamrock::solvergraph::ScalarEdge< Tscal >, mean_rho) INODE_TEX_DECL(shamrock::solvergraph::DDSharedBuffers< u32 >, idx_in_ghost) INODE_TEX_DECL(shamrock::solvergraph::RankGetter, rank_owner) INODE_TEX_DECL(shamrock::solvergraph::IFieldRefs< Tscal >, spans_phi) INODE_TEX_DECL(shamrock::solvergraph::Field< Tscal >, spans_phi_res) INODE_TEX_DECL(shamrock::solvergraph::Field< Tscal >, spans_phi_res_bis) INODE_TEX_DECL(shamrock::solvergraph::Field< Tscal >, spans_phi_p) INODE_TEX_DECL(shamrock::solvergraph::Field< Tscal >, spans_phi_Ap) INODE_TEX_DECL(shamrock::solvergraph::Field< Tscal >, spans_phi_s) INODE_TEX_DECL(shamrock::solvergraph::Field< Tscal >, spans_phi_As) INODE_TEX_DECL(shamrock::solvergraph::Field< Tscal >, spans_phi_hadamard_prod) INODE_TEX_DECL(shamrock::solvergraph::IDataEdge< Tscal >, old_values) INODE_TEX_DECL(shamrock::solvergraph::IDataEdge< Tscal >, new_values) INODE_TEX_DECL(shamrock::solvergraph::IDataEdge< Tscal >, e_norm) INODE_TEX_DECL(shamrock::solvergraph::IDataEdge< Tscal >, alpha) INODE_TEX_DECL(shamrock::solvergraph::IDataEdge< Tscal >, beta) INODE_TEX_DECL(shamrock::solvergraph::IDataEdge< Tscal >, w_stab) INODE_TEX_DECL(shamrock::solvergraph::IDataEdge< Tscal >, shadow_res_norm) INODE_TEX_DECL(shamrock::solvergraph::Field< Tscal >, spans_rhs) INODE_TEX_DECL(shamrock::solvergraph::IDataEdge< Tscal >, rhs_norm_value), INODE_TEX_GET_RO(shamrock::solvergraph::Indexes< u32 >, sizes) INODE_TEX_GET_RO(shamrock::solvergraph::Indexes< u32 >, sizes_no_gz) INODE_TEX_GET_RO(CellGraphEdge, cell_neigh_graph) INODE_TEX_GET_RO(shamrock::solvergraph::IFieldSpan< Tscal >, spans_block_cell_sizes) INODE_TEX_GET_RO(shamrock::solvergraph::IFieldSpan< Tscal >, spans_rho) INODE_TEX_GET_RO(shamrock::solvergraph::ScalarEdge< Tscal >, mean_rho) INODE_TEX_GET_RO(shamrock::solvergraph::DDSharedBuffers< u32 >, idx_in_ghost) INODE_TEX_GET_RO(shamrock::solvergraph::RankGetter, rank_owner) INODE_TEX_GET_RW(shamrock::solvergraph::IFieldRefs< Tscal >, spans_phi) INODE_TEX_GET_RW(shamrock::solvergraph::Field< Tscal >, spans_phi_res) INODE_TEX_GET_RW(shamrock::solvergraph::Field< Tscal >, spans_phi_res_bis) INODE_TEX_GET_RW(shamrock::solvergraph::Field< Tscal >, spans_phi_p) INODE_TEX_GET_RW(shamrock::solvergraph::Field< Tscal >, spans_phi_Ap) INODE_TEX_GET_RW(shamrock::solvergraph::Field< Tscal >, spans_phi_s) INODE_TEX_GET_RW(shamrock::solvergraph::Field< Tscal >, spans_phi_As) INODE_TEX_GET_RW(shamrock::solvergraph::Field< Tscal >, spans_phi_hadamard_prod) INODE_TEX_GET_RW(shamrock::solvergraph::IDataEdge< Tscal >, old_values) INODE_TEX_GET_RW(shamrock::solvergraph::IDataEdge< Tscal >, new_values) INODE_TEX_GET_RW(shamrock::solvergraph::IDataEdge< Tscal >, e_norm) INODE_TEX_GET_RW(shamrock::solvergraph::IDataEdge< Tscal >, alpha) INODE_TEX_GET_RW(shamrock::solvergraph::IDataEdge< Tscal >, beta) INODE_TEX_GET_RW(shamrock::solvergraph::IDataEdge< Tscal >, w_stab) INODE_TEX_GET_RW(shamrock::solvergraph::IDataEdge< Tscal >, shadow_res_norm) INODE_TEX_GET_RW(shamrock::solvergraph::Field< Tscal >, spans_rhs) INODE_TEX_GET_RW(shamrock::solvergraph::IDataEdge< Tscal >, rhs_norm_value), INODE_TEX_REPLACE(shamrock::solvergraph::Indexes< u32 >, sizes) INODE_TEX_REPLACE(shamrock::solvergraph::Indexes< u32 >, sizes_no_gz) INODE_TEX_REPLACE(CellGraphEdge, cell_neigh_graph) INODE_TEX_REPLACE(shamrock::solvergraph::IFieldSpan< Tscal >, spans_block_cell_sizes) INODE_TEX_REPLACE(shamrock::solvergraph::IFieldSpan< Tscal >, spans_rho) INODE_TEX_REPLACE(shamrock::solvergraph::ScalarEdge< Tscal >, mean_rho) INODE_TEX_REPLACE(shamrock::solvergraph::DDSharedBuffers< u32 >, idx_in_ghost) INODE_TEX_REPLACE(shamrock::solvergraph::RankGetter, rank_owner) INODE_TEX_REPLACE(shamrock::solvergraph::IFieldRefs< Tscal >, spans_phi) INODE_TEX_REPLACE(shamrock::solvergraph::Field< Tscal >, spans_phi_res) INODE_TEX_REPLACE(shamrock::solvergraph::Field< Tscal >, spans_phi_res_bis) INODE_TEX_REPLACE(shamrock::solvergraph::Field< Tscal >, spans_phi_p) INODE_TEX_REPLACE(shamrock::solvergraph::Field< Tscal >, spans_phi_Ap) INODE_TEX_REPLACE(shamrock::solvergraph::Field< Tscal >, spans_phi_s) INODE_TEX_REPLACE(shamrock::solvergraph::Field< Tscal >, spans_phi_As) INODE_TEX_REPLACE(shamrock::solvergraph::Field< Tscal >, spans_phi_hadamard_prod) INODE_TEX_REPLACE(shamrock::solvergraph::IDataEdge< Tscal >, old_values) INODE_TEX_REPLACE(shamrock::solvergraph::IDataEdge< Tscal >, new_values) INODE_TEX_REPLACE(shamrock::solvergraph::IDataEdge< Tscal >, e_norm) INODE_TEX_REPLACE(shamrock::solvergraph::IDataEdge< Tscal >, alpha) INODE_TEX_REPLACE(shamrock::solvergraph::IDataEdge< Tscal >, beta) INODE_TEX_REPLACE(shamrock::solvergraph::IDataEdge< Tscal >, w_stab) INODE_TEX_REPLACE(shamrock::solvergraph::IDataEdge< Tscal >, shadow_res_norm) INODE_TEX_REPLACE(shamrock::solvergraph::Field< Tscal >, spans_rhs) INODE_TEX_REPLACE(shamrock::solvergraph::IDataEdge< Tscal >, rhs_norm_value)) inline u32 get_last_iteration_count() const
Number of iterations done by the last evaluation.
Compute out <- A in, A being the matrix of the 7-point finite volume Laplacian of laplacian_7pt ( ,...
Compute res_ddot <- sum_i <res_i, res_i> over the first sizes * nvar values of every patch on every r...
Solver graph node for distributed ghost field data exchange.
Inode is node between data edges, takes multiple inputs, multiple outputs.
Definition INode.hpp:31
void __internal_set_rw_edges(std::vector< std::shared_ptr< IEdge > > new_rw_edges)
Set the read write edges.
Definition INode.hpp:249
void __internal_set_ro_edges(std::vector< std::shared_ptr< IEdge > > new_ro_edges)
Set the read only edges.
Definition INode.hpp:238
Compute z <- z + alpha * x + beta * y on every value of every patch.
Compute y <- y + alpha * x on every value of every patch.
Definition NodeAXPY.hpp:46
Compute out <- in1 * in2 (elementwise) on every value of every patch.
Compute z <- alpha_0 * z + alpha_1 * x + alpha_2 * y on every value of every patch.
Copy x into y on every value of every patch.
Compute the sum of spans_in over the first sizes * nvar values of every patch on every rank.
namespace for the basegodunov model modules
#define __shamrock_log_callsite(callsite)
Macro to create a stack entry from a given location. Can be used only on SourceLocation &&.
provide information about the source location