![]() |
Shamrock 2025.10.0
Astrophysical Code
|
Setup node generating particles on a lattice. More...
#include <shammodels/sph/include/shammodels/sph/modules/setup/GeneratorLattice.hpp>
Public Member Functions | |
| GeneratorLattice (ShamrockCtx &context, Tscal dr, std::pair< Tvec, Tvec > box, Tscal init_h_factor=default_init_h_factor) | |
| bool | is_done () |
| This function return true if the setup is done. | |
| shamrock::patch::PatchDataLayer | next_n (u32 nmax) |
| This function generate patchdata with at most nmax per MPI ranks This function is always assumed as called by every ranks simultaneously. | |
| std::string | get_name () |
| Get the name of the node. | |
| ISPHSetupNode_Dot | get_dot_subgraph () |
| Get a dot subgraph describing the node and its childrens (recursively). | |
| Public Member Functions inherited from shammodels::sph::modules::ISPHSetupNode | |
| virtual | ~ISPHSetupNode ()=default |
| Virtual destructor for the ISPHSetupNode class. | |
| std::string | get_dot () |
| Generate a dot graph for the setup tree. | |
Static Public Attributes | |
| static constexpr Tscal | default_init_h_factor = LatticeProperties<Lattice>::default_init_h_factor |
| Default ratio between the initial smoothing length and dr (see LatticeProperties). | |
Setup node generating particles on a lattice.
| Tvec | position vector type |
| Lattice | lattice class (shammath::LatticeHCP, LatticeFCC or LatticeCubic) |
| discontinuous | if true, use the discontinuous lattice iterator |
Definition at line 68 of file GeneratorLattice.hpp.
|
inline |
Definition at line 97 of file GeneratorLattice.hpp.
|
inlinevirtual |
Get a dot subgraph describing the node and its childrens (recursively).
This function should return a ISPHSetupNode_Dot object which contains all the information needed to generate a dot graph for the node and its children.
Implements shammodels::sph::modules::ISPHSetupNode.
Definition at line 169 of file GeneratorLattice.hpp.
|
inlinevirtual |
Get the name of the node.
Implements shammodels::sph::modules::ISPHSetupNode.
Definition at line 168 of file GeneratorLattice.hpp.
|
inlinevirtual |
This function return true if the setup is done.
Implements shammodels::sph::modules::ISPHSetupNode.
Definition at line 105 of file GeneratorLattice.hpp.
|
inlinevirtual |
This function generate patchdata with at most nmax per MPI ranks This function is always assumed as called by every ranks simultaneously.
| nmax |
Implements shammodels::sph::modules::ISPHSetupNode.
Definition at line 107 of file GeneratorLattice.hpp.
|
staticconstexpr |
Default ratio between the initial smoothing length and dr (see LatticeProperties).
Definition at line 85 of file GeneratorLattice.hpp.