Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
shammodels::sph::modules::ModifierApplyCustomWarp< Tvec, SPHKernel > Class Template Reference
Inheritance diagram for shammodels::sph::modules::ModifierApplyCustomWarp< Tvec, SPHKernel >:
Collaboration diagram for shammodels::sph::modules::ModifierApplyCustomWarp< Tvec, SPHKernel >:

Public Member Functions

 ModifierApplyCustomWarp (ShamrockCtx &context, Config &solver_config, SetupNodePtr parent, std::function< Tscal(Tscal)> inc_profile, std::function< Tscal(Tscal)> psi_profile, std::function< Tvec(Tscal)> k_profile)
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, template< class > class SPHKernel>
class shammodels::sph::modules::ModifierApplyCustomWarp< Tvec, SPHKernel >

Definition at line 27 of file ModifierApplyCustomWarp.hpp.

Constructor & Destructor Documentation

◆ ModifierApplyCustomWarp()

template<class Tvec, template< class > class SPHKernel>
shammodels::sph::modules::ModifierApplyCustomWarp< Tvec, SPHKernel >::ModifierApplyCustomWarp ( ShamrockCtx & context,
Config & solver_config,
SetupNodePtr parent,
std::function< Tscal(Tscal)> inc_profile,
std::function< Tscal(Tscal)> psi_profile,
std::function< Tvec(Tscal)> k_profile )
inline

Definition at line 41 of file ModifierApplyCustomWarp.hpp.

Member Function Documentation

◆ get_dot_subgraph()

template<class Tvec, template< class > class SPHKernel>
ISPHSetupNode_Dot shammodels::sph::modules::ModifierApplyCustomWarp< Tvec, SPHKernel >::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 57 of file ModifierApplyCustomWarp.hpp.

Here is the call graph for this function:

◆ get_name()

template<class Tvec, template< class > class SPHKernel>
std::string shammodels::sph::modules::ModifierApplyCustomWarp< Tvec, SPHKernel >::get_name ( )
inlinevirtual

Get the name of the node.

Returns
The name of the node

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

Definition at line 55 of file ModifierApplyCustomWarp.hpp.

◆ is_done()

template<class Tvec, template< class > class SPHKernel>
bool shammodels::sph::modules::ModifierApplyCustomWarp< Tvec, SPHKernel >::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 51 of file ModifierApplyCustomWarp.hpp.

◆ next_n()

template<class Tvec, template< class > class SPHKernel>
shamrock::patch::PatchDataLayer shammodels::sph::modules::ModifierApplyCustomWarp< Tvec, SPHKernel >::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 28 of file ModifierApplyCustomWarp.cpp.

Here is the call graph for this function:

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