Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
Public Member Functions | List of all members
shammodels::sph::modules::CombinerAdd< Tvec > Class Template Reference
+ Inheritance diagram for shammodels::sph::modules::CombinerAdd< Tvec >:
+ Collaboration diagram for shammodels::sph::modules::CombinerAdd< Tvec >:

Public Member Functions

 CombinerAdd (ShamrockCtx &context, SetupNodePtr parent1, SetupNodePtr parent2)
 
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.
 

Detailed Description

template<class Tvec>
class shammodels::sph::modules::CombinerAdd< Tvec >

Definition at line 28 of file CombinerAdd.hpp.

Constructor & Destructor Documentation

◆ CombinerAdd()

template<class Tvec >
shammodels::sph::modules::CombinerAdd< Tvec >::CombinerAdd ( ShamrockCtx context,
SetupNodePtr  parent1,
SetupNodePtr  parent2 
)
inline

Definition at line 40 of file CombinerAdd.hpp.

Member Function Documentation

◆ get_dot_subgraph()

template<class Tvec >
ISPHSetupNode_Dot shammodels::sph::modules::CombinerAdd< Tvec >::get_dot_subgraph ( )
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.

Returns
A ISPHSetupNode_Dot object

Implements shammodels::sph::modules::ISPHSetupNode.

Definition at line 58 of file CombinerAdd.hpp.

+ Here is the call graph for this function:

◆ get_name()

template<class Tvec >
std::string shammodels::sph::modules::CombinerAdd< Tvec >::get_name ( )
inlinevirtual

Get the name of the node.

Returns
The name of the node

Implements shammodels::sph::modules::ISPHSetupNode.

Definition at line 57 of file CombinerAdd.hpp.

◆ is_done()

template<class Tvec >
bool shammodels::sph::modules::CombinerAdd< Tvec >::is_done ( )
inlinevirtual

This function return true if the setup is done.

Returns
true if done, false otherwise

Implements shammodels::sph::modules::ISPHSetupNode.

Definition at line 43 of file CombinerAdd.hpp.

◆ next_n()

template<class Tvec >
shamrock::patch::PatchDataLayer shammodels::sph::modules::CombinerAdd< Tvec >::next_n ( u32  nmax)
inlinevirtual

This function generate patchdata with at most nmax per MPI ranks This function is always assumed as called by every ranks simultaneously.

Parameters
nmax
Returns
shamrock::patch::PatchData

Implements shammodels::sph::modules::ISPHSetupNode.

Definition at line 45 of file CombinerAdd.hpp.


The documentation for this class was generated from the following file: