shammodels::sph::modules::ModifierOffset< Tvec > Class Template Reference

Inheritance diagram for shammodels::sph::modules::ModifierOffset< Tvec >:

Collaboration diagram for shammodels::sph::modules::ModifierOffset< Tvec >:

Public Member Functions
	ModifierOffset (ShamrockCtx &context, SetupNodePtr parent, Tvec positional_offset, Tvec velocity_offset)
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::ModifierOffset< Tvec >

Definition at line 27 of file ModifierOffset.hpp.

Constructor & Destructor Documentation

ModifierOffset()

template<class Tvec >

shammodels::sph::modules::ModifierOffset< Tvec >::ModifierOffset ( ShamrockCtx &  context, SetupNodePtr  parent, Tvec  positional_offset, Tvec  velocity_offset  )

inline

Definition at line 39 of file ModifierOffset.hpp.

Member Function Documentation

get_dot_subgraph()

template<class Tvec >

ISPHSetupNode_Dot shammodels::sph::modules::ModifierOffset< 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 49 of file ModifierOffset.hpp.

Here is the call graph for this function:

get_name()

template<class Tvec >

std::string shammodels::sph::modules::ModifierOffset< Tvec >::get_name ( )

inlinevirtual

Get the name of the node.

Returns

The name of the node

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

Definition at line 48 of file ModifierOffset.hpp.

is_done()

template<class Tvec >

bool shammodels::sph::modules::ModifierOffset< 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 44 of file ModifierOffset.hpp.

next_n()

template<class Tvec >

shamrock::patch::PatchDataLayer shammodels::sph::modules::ModifierOffset< Tvec >::next_n ( u32  nmax )

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

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

Definition at line 23 of file ModifierOffset.cpp.

Here is the call graph for this function:

---

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

• shammodels/sph/include/shammodels/sph/modules/setup/ModifierOffset.hpp
• shammodels/sph/src/modules/setup/ModifierOffset.cpp