Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
NodeCGLoop.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
21
23#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_p) \
65 X_RW(shamrock::solvergraph::Field<Tscal>, spans_phi_Ap) \
66 X_RW(shamrock::solvergraph::Field<Tscal>, spans_phi_hadamard_prod) \
67 X_RW(shamrock::solvergraph::Field<Tscal>, spans_phi_rhs) \
68 X_RW(shamrock::solvergraph::Field<Tscal>, spans_phi_z) \
69 X_RW(shamrock::solvergraph::IDataEdge<Tscal>, old_values) \
70 X_RW(shamrock::solvergraph::IDataEdge<Tscal>, new_values) \
71 X_RW(shamrock::solvergraph::IDataEdge<Tscal>, e_norm) \
72 X_RW(shamrock::solvergraph::IDataEdge<Tscal>, alpha) \
73 X_RW(shamrock::solvergraph::IDataEdge<Tscal>, beta) \
74 X_RW(shamrock::solvergraph::IDataEdge<Tscal>, rhs_norm_values) \
75 X_RW(shamrock::solvergraph::IDataEdge<Tscal>, rz_old_values) \
76 X_RW(shamrock::solvergraph::IDataEdge<Tscal>, rz_new_values) \
77 X_RW(shamrock::solvergraph::Field<Tscal>, spans_rz_hadamard_prod)
78
80
106 template<class Tvec, class TgridVec>
107 class NodeCGLoop : public shamrock::solvergraph::INode {
108 using Tscal = shambase::VecComponent<Tvec>;
110
111 u32 block_size;
112 Tscal fourPiG;
113 u32 Niter_max;
114 Tscal tol;
115
116 u32 last_iteration_count = 0;
117
119 CGInit<Tvec, TgridVec> cg_init_node{block_size, fourPiG};
121 ResidualDot<Tscal> res_ddot_node{block_size};
123 ResidualDot<Tscal> rhs_node{block_size};
125 NodeSpMVPoisson3D<Tvec, TgridVec> spmv_node{block_size};
127 shamrock::solvergraph::NodeHadamardProd<Tscal> hadamard_prod_node{block_size};
131 shamrock::solvergraph::NodeAXPY<Tscal> new_potential_node{block_size};
133 shamrock::solvergraph::NodeAXPY<Tscal> new_residual_node{block_size};
135 NodeJacobiPreconditioner<Tvec, TgridVec> res_precond_node{block_size};
137 ResidualDot<Tscal> res_ddot_new_node{block_size};
139 shamrock::solvergraph::NodeHadamardProd<Tscal> rz_hadamard_prod_node{block_size};
141 shamrock::solvergraph::NodeSumReduction<Tscal> rz_reduction_node{block_size};
143 shamrock::solvergraph::NodeSumReduction<Tscal> rz_new_reduction_node{block_size};
145 shamrock::solvergraph::NodeAYPX<Tscal> new_p_node{block_size};
146
147 std::shared_ptr<shamrock::solvergraph::PatchDataFieldDDShared<Tscal>> p_ghosts
148 = std::make_shared<shamrock::solvergraph::PatchDataFieldDDShared<Tscal>>(
149 "p_ghosts", "p_{\\rm ghosts}");
153 // ghost exchange of phi at the end of the solve (shares the temporary ghost edge of p)
157
158 public:
159 NodeCGLoop(u32 block_size, Tscal fourPiG, u32 Niter_max, Tscal tol)
160 : block_size(block_size), fourPiG(fourPiG), Niter_max(Niter_max), tol(tol) {}
161
162 // same as EXPAND_NODE_EDGES(NODE_EDGES), with set_edges also wiring the inner nodes
163 struct Edges {
164 NODE_EDGES(INODE_DECL_RO, INODE_DECL_RW)
165 };
166
167 inline void set_edges(
168 NODE_EDGES(INODE_PARAM_RO, INODE_PARAM_RW) SourceLocation loc = SourceLocation{}) {
170
171 __internal_set_ro_edges({NODE_EDGES(INODE_PUSH_RO1, INODE_PUSH_RW1)});
172 __internal_set_rw_edges({NODE_EDGES(INODE_PUSH_RO2, INODE_PUSH_RW2)});
173
174 cg_init_node.set_edges(
175 sizes,
176 cell_neigh_graph,
177 spans_block_cell_sizes,
178 spans_phi,
179 spans_rho,
180 mean_rho,
181 spans_phi_res,
182 spans_phi_p,
183 spans_phi_rhs,
184 spans_phi_z);
185 res_ddot_node.set_edges(sizes_no_gz, spans_phi_res, old_values);
186 rhs_node.set_edges(sizes_no_gz, spans_phi_rhs, rhs_norm_values);
187 spmv_node.set_edges(
188 sizes, cell_neigh_graph, spans_block_cell_sizes, spans_phi_p, spans_phi_Ap);
189 hadamard_prod_node.set_edges(sizes, spans_phi_p, spans_phi_Ap, spans_phi_hadamard_prod);
190 a_norm_node.set_edges(sizes_no_gz, spans_phi_hadamard_prod, e_norm);
191 new_potential_node.set_edges(sizes, spans_phi_p, alpha, spans_phi);
192 new_residual_node.set_edges(sizes, spans_phi_Ap, alpha, spans_phi_res);
193 res_precond_node.set_edges(
194 sizes, cell_neigh_graph, spans_block_cell_sizes, spans_phi_res, spans_phi_z);
195 res_ddot_new_node.set_edges(sizes_no_gz, spans_phi_res, new_values);
196 rz_hadamard_prod_node.set_edges(
197 sizes, spans_phi_res, spans_phi_z, spans_rz_hadamard_prod);
198 rz_reduction_node.set_edges(sizes_no_gz, spans_rz_hadamard_prod, rz_old_values);
199 rz_new_reduction_node.set_edges(sizes_no_gz, spans_rz_hadamard_prod, rz_new_values);
200 new_p_node.set_edges(sizes, spans_phi_z, beta, spans_phi_p);
201
202 node_gz_p.set_edges(spans_phi_p, idx_in_ghost, p_ghosts);
203 node_exch_gz_p.set_edges(rank_owner, p_ghosts);
204 node_replace_gz_p.set_edges(p_ghosts, spans_phi_p);
205
206 node_gz_phi.set_edges(spans_phi, idx_in_ghost, p_ghosts);
207 node_exch_gz_phi.set_edges(rank_owner, p_ghosts);
208 node_replace_gz_phi.set_edges(p_ghosts, spans_phi);
209 }
210
211 inline Edges get_edges() {
212 int ro = 0;
213 int rw = 0;
214 return Edges{NODE_EDGES(INODE_GET_RO, INODE_GET_RW)};
215 }
216
218 NODE_EDGES(INODE_TEX_DECL, INODE_TEX_DECL),
219 NODE_EDGES(INODE_TEX_GET_RO, INODE_TEX_GET_RW),
220 NODE_EDGES(INODE_TEX_REPLACE, INODE_TEX_REPLACE))
221
222
223 inline u32 get_last_iteration_count() const { return last_iteration_count; }
224
226
227 inline virtual std::string _impl_get_label() const { return "CGMainLoop"; };
228
229 virtual std::string _impl_get_tex() const;
230 };
231
232} // namespace shammodels::basegodunov::modules
233
234#undef NODE_EDGES
#define NODE_EDGES(X_RO, X_RW)
declare the list of edges for this node
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 y <- y + alpha * x on fields.
Node computing the in place update y <- alpha * y + x on fields.
Node computing the elementwise (Hadamard) product of two fields.
Diagonal preconditioner of the PCG Poisson solver.
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
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_p) INODE_TEX_DECL(shamrock::solvergraph::Field< Tscal >, spans_phi_Ap) INODE_TEX_DECL(shamrock::solvergraph::Field< Tscal >, spans_phi_hadamard_prod) INODE_TEX_DECL(shamrock::solvergraph::Field< Tscal >, spans_phi_rhs) INODE_TEX_DECL(shamrock::solvergraph::Field< Tscal >, spans_phi_z) 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 >, rhs_norm_values) INODE_TEX_DECL(shamrock::solvergraph::IDataEdge< Tscal >, rz_old_values) INODE_TEX_DECL(shamrock::solvergraph::IDataEdge< Tscal >, rz_new_values) INODE_TEX_DECL(shamrock::solvergraph::Field< Tscal >, spans_rz_hadamard_prod), 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_p) INODE_TEX_GET_RW(shamrock::solvergraph::Field< Tscal >, spans_phi_Ap) INODE_TEX_GET_RW(shamrock::solvergraph::Field< Tscal >, spans_phi_hadamard_prod) INODE_TEX_GET_RW(shamrock::solvergraph::Field< Tscal >, spans_phi_rhs) INODE_TEX_GET_RW(shamrock::solvergraph::Field< Tscal >, spans_phi_z) 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 >, rhs_norm_values) INODE_TEX_GET_RW(shamrock::solvergraph::IDataEdge< Tscal >, rz_old_values) INODE_TEX_GET_RW(shamrock::solvergraph::IDataEdge< Tscal >, rz_new_values) INODE_TEX_GET_RW(shamrock::solvergraph::Field< Tscal >, spans_rz_hadamard_prod), 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_p) INODE_TEX_REPLACE(shamrock::solvergraph::Field< Tscal >, spans_phi_Ap) INODE_TEX_REPLACE(shamrock::solvergraph::Field< Tscal >, spans_phi_hadamard_prod) INODE_TEX_REPLACE(shamrock::solvergraph::Field< Tscal >, spans_phi_rhs) INODE_TEX_REPLACE(shamrock::solvergraph::Field< Tscal >, spans_phi_z) 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 >, rhs_norm_values) INODE_TEX_REPLACE(shamrock::solvergraph::IDataEdge< Tscal >, rz_old_values) INODE_TEX_REPLACE(shamrock::solvergraph::IDataEdge< Tscal >, rz_new_values) INODE_TEX_REPLACE(shamrock::solvergraph::Field< Tscal >, spans_rz_hadamard_prod)) inline u32 get_last_iteration_count() const
Number of iterations done by the last evaluation.
virtual std::string _impl_get_tex() const
get the tex of the node
void _impl_evaluate_internal()
evaluate the node
virtual std::string _impl_get_label() const
get the label of the node
Compute y <- M^-1 x, being the diagonal of the matrix of NodeSpMVPoisson3D as given by jacobi_weight...
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 y <- y + alpha * x on every value of every patch.
Definition NodeAXPY.hpp:46
Compute y <- alpha * y + x on every value of every patch.
Definition NodeAYPX.hpp:46
Compute out <- in1 * in2 (elementwise) 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