![]() |
Shamrock 2025.10.0
Astrophysical Code
|
Solve \( \Delta \phi = 4 \pi G (\rho - \bar{\rho}) \) with the Jacobi preconditioned conjugate gradient method, starting from the current content of spans_phi. More...
#include <shammodels/ramses/include/shammodels/ramses/modules/NodeCGLoop.hpp>
Classes | |
| struct | Edges |
Public Member Functions | |
| NodeCGLoop (u32 block_size, Tscal fourPiG, u32 Niter_max, Tscal tol) | |
| void | set_edges (INODE_PARAM_RO(shamrock::solvergraph::Indexes< u32 >, sizes) INODE_PARAM_RO(shamrock::solvergraph::Indexes< u32 >, sizes_no_gz) INODE_PARAM_RO(CellGraphEdge, cell_neigh_graph) INODE_PARAM_RO(shamrock::solvergraph::IFieldSpan< Tscal >, spans_block_cell_sizes) INODE_PARAM_RO(shamrock::solvergraph::IFieldSpan< Tscal >, spans_rho) INODE_PARAM_RO(shamrock::solvergraph::ScalarEdge< Tscal >, mean_rho) INODE_PARAM_RO(shamrock::solvergraph::DDSharedBuffers< u32 >, idx_in_ghost) INODE_PARAM_RO(shamrock::solvergraph::RankGetter, rank_owner) INODE_PARAM_RW(shamrock::solvergraph::IFieldRefs< Tscal >, spans_phi) INODE_PARAM_RW(shamrock::solvergraph::Field< Tscal >, spans_phi_res) INODE_PARAM_RW(shamrock::solvergraph::Field< Tscal >, spans_phi_p) INODE_PARAM_RW(shamrock::solvergraph::Field< Tscal >, spans_phi_Ap) INODE_PARAM_RW(shamrock::solvergraph::Field< Tscal >, spans_phi_hadamard_prod) INODE_PARAM_RW(shamrock::solvergraph::Field< Tscal >, spans_phi_rhs) INODE_PARAM_RW(shamrock::solvergraph::Field< Tscal >, spans_phi_z) INODE_PARAM_RW(shamrock::solvergraph::IDataEdge< Tscal >, old_values) INODE_PARAM_RW(shamrock::solvergraph::IDataEdge< Tscal >, new_values) INODE_PARAM_RW(shamrock::solvergraph::IDataEdge< Tscal >, e_norm) INODE_PARAM_RW(shamrock::solvergraph::IDataEdge< Tscal >, alpha) INODE_PARAM_RW(shamrock::solvergraph::IDataEdge< Tscal >, beta) INODE_PARAM_RW(shamrock::solvergraph::IDataEdge< Tscal >, rhs_norm_values) INODE_PARAM_RW(shamrock::solvergraph::IDataEdge< Tscal >, rz_old_values) INODE_PARAM_RW(shamrock::solvergraph::IDataEdge< Tscal >, rz_new_values) INODE_PARAM_RW(shamrock::solvergraph::Field< Tscal >, spans_rz_hadamard_prod) SourceLocation loc=SourceLocation{}) |
| Edges | get_edges () |
| 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. | |
| void | _impl_evaluate_internal () |
| evaluate the node | |
| virtual std::string | _impl_get_label () const |
| get the label of the node | |
| virtual std::string | _impl_get_tex () const |
| get the tex of the node | |
| Public Member Functions inherited from shamrock::solvergraph::INode | |
| INode (const INode &)=delete | |
| INode & | operator= (const INode &)=delete |
| would violate shared_from_this() & unique UUID | |
| INode (INode &&) noexcept=default | |
| would violate shared_from_this() & unique UUID | |
| INode & | operator= (INode &&) noexcept=default |
| Move assignment - automatically delegates to base classes and members. | |
| u64 | get_uuid () const |
| Get the UUID of the node. | |
| std::shared_ptr< INode > | getptr_shared () |
| Get a shared pointer to this node. | |
| std::weak_ptr< INode > | getptr_weak () |
| Get a weak pointer to this node. | |
| std::vector< std::shared_ptr< IEdge > > & | get_ro_edges () |
| Get the read only edges. | |
| std::vector< std::shared_ptr< IEdge > > & | get_rw_edges () |
| Get the read write edges. | |
| void | __internal_set_ro_edges (std::vector< std::shared_ptr< IEdge > > new_ro_edges) |
| Set the read only edges. | |
| void | __internal_set_rw_edges (std::vector< std::shared_ptr< IEdge > > new_rw_edges) |
| Set the read write edges. | |
| template<class Func> | |
| void | on_edge_ro_edges (Func &&f) |
| Apply a function to the read only edges. | |
| template<class Func> | |
| void | on_edge_rw_edges (Func &&f) |
| Apply a function to the read write edges. | |
| virtual | ~INode () |
| template<class T> | |
| const T & | get_ro_edge (int slot) |
| Get a read only edge and cast it to the type T. | |
| template<class T> | |
| T & | get_rw_edge (int slot) |
| Get a read write edge and cast it to the type T. | |
| template<class T> | |
| std::optional< std::reference_wrapper< const T > > | get_ro_edge_optional (int slot) |
| Get a read only edge and cast it to the type T, return an optional. | |
| template<class T> | |
| std::optional< std::reference_wrapper< T > > | get_rw_edge_optional (int slot) |
| Get a read write edge and cast it to the type T, return an optional. | |
| const IEdge & | get_ro_edge_base (int slot) |
| Get a reference to a read only edge. | |
| const IEdge & | get_ro_edge_base (int slot) const |
| IEdge & | get_rw_edge_base (int slot) |
| Get a reference to a read write edge and cast it to the type IEdge. | |
| const IEdge & | get_rw_edge_base (int slot) const |
| void | evaluate () |
| Evaluate the node. | |
| std::string | get_dot_graph () |
| Get the dot graph of the node (Currently only an alias to get_dot_graph_partial). | |
| std::string | get_dot_graph_partial () |
| Get the dot graph of the subgraph corresponding to the node. | |
| std::string | get_dot_graph_node_start () |
| Get the id of the node start in the dot graph. | |
| std::string | get_dot_graph_node_end () |
| Get the id of the node end in the dot graph. | |
| std::string | get_tex () |
| Get the TeX of the node. | |
| std::string | get_tex_partial () |
| Get the TeX of the node partial. | |
| std::string | get_label () const |
| Get the label of the node. | |
| virtual std::string | print_node_info () const |
| print the node info | |
Additional Inherited Members | |
| Protected Member Functions inherited from shamrock::solvergraph::INode | |
| void | notify_self_state_update () |
| virtual std::string | _impl_get_dot_graph_partial () const |
| get the dot graph of the node partial | |
| virtual std::string | _impl_get_dot_graph_node_start () const |
| get the dot graph of the node start | |
| virtual std::string | _impl_get_dot_graph_node_end () const |
| get the dot graph of the node end | |
Solve \( \Delta \phi = 4 \pi G (\rho - \bar{\rho}) \) with the Jacobi preconditioned conjugate gradient method, starting from the current content of spans_phi.
This is the CG gravity mode of the new_amr_plus_grav branch of Léodasce Sewanou, which is a preconditioned CG: \( z_0 = p_0 = r_0 / A_{ii} \) (CGInit), then \( z_{k+1} = M^{-1} r_{k+1} \) (NodeJacobiPreconditioner), \( \alpha_k = \langle r_k, z_k \rangle / \langle p_k, A p_k \rangle \), \( \beta_k = \langle r_{k+1}, z_{k+1} \rangle / \langle r_k, z_k \rangle \) and \( p_{k+1} = z_{k+1} + \beta_k p_k \). On a uniform grid \( M \) is a multiple of the identity, so the iterates are the ones of the plain CG.
The matrix is the one of NodeSpMVPoisson3D ( \( -\Delta x^3 \Delta \), see laplacian_7pt) and the right-hand side the one of CGInit. sizes holds the block counts per patch including the ghost blocks, stored after the patch blocks, sizes_no_gz the block counts without them: the vectors are updated on the ghost blocks too, but the dot products only sum the patch blocks. The ghost blocks of the search direction are exchanged at the start of every iteration, and the ones of \( \phi \) at the end (idx_in_ghost, rank_owner).
The loop stops when \( \langle r, r \rangle / \langle b, b \rangle < {\rm tol}^2 \) or after Niter_max iterations. On exit old_values holds \( \langle r, r \rangle \) and rhs_norm_values \( \langle b, b \rangle \).
The work fields are resized to match sizes if needed.
Definition at line 107 of file NodeCGLoop.hpp.
|
inline |
Definition at line 159 of file NodeCGLoop.hpp.
|
virtual |
evaluate the node
Implements shamrock::solvergraph::INode.
Definition at line 30 of file NodeCGLoop.cpp.
|
inlinevirtual |
get the label of the node
Implements shamrock::solvergraph::INode.
Definition at line 227 of file NodeCGLoop.hpp.
|
virtual |
get the tex of the node
Implements shamrock::solvergraph::INode.
Definition at line 156 of file NodeCGLoop.cpp.
|
inline |
Definition at line 211 of file NodeCGLoop.hpp.
|
inline |
Number of iterations done by the last evaluation.
Definition at line 217 of file NodeCGLoop.hpp.
|
inline |
Definition at line 167 of file NodeCGLoop.hpp.