shammodels::sph::modules::ISPHSetupNode Class Reference

This class is an interface that all SPH setup nodes must implement. It describe an operation associated to a node in the setup tree. More...

#include <shammodels/sph/include/shammodels/sph/modules/setup/ISPHSetupNode.hpp>

Inheritance diagram for shammodels::sph::modules::ISPHSetupNode:

Public Member Functions
virtual bool	is_done ()=0
	This function return true if the setup is done.
virtual shamrock::patch::PatchDataLayer	next_n (u32 nmax)=0
	This function generate patchdata with at most nmax per MPI ranks This function is always assumed as called by every ranks simultaneously.
virtual std::string	get_name ()=0
	Get the name of the node.
virtual ISPHSetupNode_Dot	get_dot_subgraph ()=0
	Get a dot subgraph describing the node and its childrens (recursively)
virtual	~ISPHSetupNode ()=default
	Virtual destructor for the ISPHSetupNode class.
std::string	get_dot ()
	Generate a dot graph for the setup tree.

Detailed Description

This class is an interface that all SPH setup nodes must implement. It describe an operation associated to a node in the setup tree.

Definition at line 74 of file ISPHSetupNode.hpp.

Member Function Documentation

get_dot()

std::string shammodels::sph::modules::ISPHSetupNode::get_dot ( )

inline

Generate a dot graph for the setup tree.

This function returns a string containing a dot graph that describes the setup tree.

Returns

A string containing a dot graph

Definition at line 122 of file ISPHSetupNode.hpp.

Here is the call graph for this function:

get_dot_subgraph()

virtual ISPHSetupNode_Dot shammodels::sph::modules::ISPHSetupNode::get_dot_subgraph ( )

pure virtual

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

Implemented in shammodels::sph::modules::CombinerAdd< Tvec >, shammodels::sph::modules::GeneratorFromOtherContext< Tvec >, shammodels::sph::modules::GeneratorLatticeCubic< Tvec >, shammodels::sph::modules::GeneratorLatticeHCP< Tvec, Discontinuous >, shammodels::sph::modules::GeneratorMCDisc< Tvec, SPHKernel >, shammodels::sph::modules::ModifierApplyCustomWarp< Tvec, SPHKernel >, shammodels::sph::modules::ModifierApplyDiscWarp< Tvec, SPHKernel >, shammodels::sph::modules::ModifierFilter< Tvec, SPHKernel >, shammodels::sph::modules::ModifierOffset< Tvec >, and shammodels::sph::modules::ModifierSplitPart< Tvec >.

get_name()

virtual std::string shammodels::sph::modules::ISPHSetupNode::get_name ( )

pure virtual

Get the name of the node.

Returns

The name of the node

Implemented in shammodels::sph::modules::CombinerAdd< Tvec >, shammodels::sph::modules::GeneratorFromOtherContext< Tvec >, shammodels::sph::modules::GeneratorLatticeCubic< Tvec >, shammodels::sph::modules::GeneratorLatticeHCP< Tvec, Discontinuous >, shammodels::sph::modules::GeneratorMCDisc< Tvec, SPHKernel >, shammodels::sph::modules::ModifierApplyCustomWarp< Tvec, SPHKernel >, shammodels::sph::modules::ModifierApplyDiscWarp< Tvec, SPHKernel >, shammodels::sph::modules::ModifierFilter< Tvec, SPHKernel >, shammodels::sph::modules::ModifierOffset< Tvec >, and shammodels::sph::modules::ModifierSplitPart< Tvec >.

is_done()

virtual bool shammodels::sph::modules::ISPHSetupNode::is_done ( )

pure virtual

This function return true if the setup is done.

Returns

true if done, false otherwise

Implemented in shammodels::sph::modules::CombinerAdd< Tvec >, shammodels::sph::modules::GeneratorFromOtherContext< Tvec >, shammodels::sph::modules::GeneratorLatticeCubic< Tvec >, shammodels::sph::modules::GeneratorLatticeHCP< Tvec, Discontinuous >, shammodels::sph::modules::GeneratorMCDisc< Tvec, SPHKernel >, shammodels::sph::modules::ModifierApplyCustomWarp< Tvec, SPHKernel >, shammodels::sph::modules::ModifierApplyDiscWarp< Tvec, SPHKernel >, shammodels::sph::modules::ModifierFilter< Tvec, SPHKernel >, shammodels::sph::modules::ModifierOffset< Tvec >, and shammodels::sph::modules::ModifierSplitPart< Tvec >.

next_n()

virtual shamrock::patch::PatchDataLayer shammodels::sph::modules::ISPHSetupNode::next_n ( u32  nmax )

pure virtual

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

Implemented in shammodels::sph::modules::CombinerAdd< Tvec >, shammodels::sph::modules::GeneratorFromOtherContext< Tvec >, shammodels::sph::modules::GeneratorLatticeCubic< Tvec >, shammodels::sph::modules::GeneratorLatticeHCP< Tvec, Discontinuous >, shammodels::sph::modules::GeneratorMCDisc< Tvec, SPHKernel >, shammodels::sph::modules::ModifierApplyCustomWarp< Tvec, SPHKernel >, shammodels::sph::modules::ModifierApplyDiscWarp< Tvec, SPHKernel >, shammodels::sph::modules::ModifierFilter< Tvec, SPHKernel >, shammodels::sph::modules::ModifierOffset< Tvec >, and shammodels::sph::modules::ModifierSplitPart< Tvec >.

---

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

• shammodels/sph/include/shammodels/sph/modules/setup/ISPHSetupNode.hpp