shammodels::sph::modules::GeneratorMCDisc< Tvec, SPHKernel > Class Template Reference

Inheritance diagram for shammodels::sph::modules::GeneratorMCDisc< Tvec, SPHKernel >:

Collaboration diagram for shammodels::sph::modules::GeneratorMCDisc< Tvec, SPHKernel >:

Classes
class	DiscIterator

Public Member Functions
	GeneratorMCDisc (ShamrockCtx &context, Config &solver_config, Tscal part_mass, Tscal disc_mass, Tscal r_in, Tscal r_out, std::function< Tscal(Tscal)> sigma_profile, std::function< Tscal(Tscal)> H_profile, std::function< Tscal(Tscal)> rot_profile, std::function< Tscal(Tscal)> cs_profile, std::mt19937_64 eng, Tscal 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.

Detailed Description

template<class Tvec, template< class > class SPHKernel>
class shammodels::sph::modules::GeneratorMCDisc< Tvec, SPHKernel >

Definition at line 29 of file GeneratorMCDisc.hpp.

Constructor & Destructor Documentation

GeneratorMCDisc()

template<class Tvec , template< class > class SPHKernel>

shammodels::sph::modules::GeneratorMCDisc< Tvec, SPHKernel >::GeneratorMCDisc ( ShamrockCtx &  context, Config &  solver_config, Tscal  part_mass, Tscal  disc_mass, Tscal  r_in, Tscal  r_out, std::function< Tscal(Tscal)>  sigma_profile, std::function< Tscal(Tscal)>  H_profile, std::function< Tscal(Tscal)>  rot_profile, std::function< Tscal(Tscal)>  cs_profile, std::mt19937_64  eng, Tscal  init_h_factor  )

inline

Definition at line 75 of file GeneratorMCDisc.hpp.

Member Function Documentation

get_dot_subgraph()

template<class Tvec , template< class > class SPHKernel>

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

Here is the call graph for this function:

get_name()

template<class Tvec , template< class > class SPHKernel>

std::string shammodels::sph::modules::GeneratorMCDisc< 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 104 of file GeneratorMCDisc.hpp.

is_done()

template<class Tvec , template< class > class SPHKernel>

bool shammodels::sph::modules::GeneratorMCDisc< Tvec, SPHKernel >::is_done ( )

virtual

This function return true if the setup is done.

Returns

true if done, false otherwise

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

Definition at line 77 of file GeneratorMCDisc.cpp.

next_n()

template<class Tvec , template< class > class SPHKernel>

shamrock::patch::PatchDataLayer shammodels::sph::modules::GeneratorMCDisc< 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 82 of file GeneratorMCDisc.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/GeneratorMCDisc.hpp
• shammodels/sph/src/modules/setup/GeneratorMCDisc.cpp