ParticleCouplingParameters< dim > Class Template Reference

Stores parameters related to particle coupling in a simulation. More...

#include <particle_coupling.h>

Inheritance diagram for ParticleCouplingParameters< dim >:

Public Member Functions
	ParticleCouplingParameters ()
	Constructor that initializes the parameters.
Public Member Functions inherited from ParameterAcceptor
	ParameterAcceptor (const std::string &section_name="")
unsigned int	get_acceptor_id () const
virtual	~ParameterAcceptor () override
virtual void	declare_parameters (ParameterHandler &prm)
virtual void	parse_parameters (ParameterHandler &prm)
std::string	get_section_name () const
std::vector< std::string >	get_section_path () const
void	add_parameter (const std::string &entry, ParameterType &parameter, const std::string &documentation="", ParameterHandler &prm_=prm, const Patterns::PatternBase &pattern=*Patterns::Tools::Convert< ParameterType >::to_pattern())
void	enter_subsection (const std::string &subsection)
void	leave_subsection ()
void	enter_my_subsection (ParameterHandler &prm)
void	leave_my_subsection (ParameterHandler &prm)
void	serialize (Archive &ar, const unsigned int version)
unsigned int	n_subscriptions () const
void	list_subscribers (StreamType &stream) const
void	list_subscribers () const
unsigned int	n_subscriptions () const
void	list_subscribers (StreamType &stream) const
void	list_subscribers () const
Public Member Functions inherited from EnableObserverPointer
	EnableObserverPointer ()
	EnableObserverPointer (const EnableObserverPointer &)
	EnableObserverPointer (EnableObserverPointer &&) noexcept
virtual	~EnableObserverPointer ()
EnableObserverPointer &	operator= (const EnableObserverPointer &)
EnableObserverPointer &	operator= (EnableObserverPointer &&) noexcept
void	serialize (Archive &ar, const unsigned int version)
unsigned int	n_subscriptions () const
void	list_subscribers (StreamType &stream) const
void	list_subscribers () const
unsigned int	n_subscriptions () const
void	list_subscribers (StreamType &stream) const
void	list_subscribers () const

Public Attributes
unsigned int	rtree_extraction_level = 1
Public Attributes inherited from ParameterAcceptor
boost::signals2::signal< void()>	declare_parameters_call_back
boost::signals2::signal< void()>	parse_parameters_call_back

Additional Inherited Members
Static Public Member Functions inherited from ParameterAcceptor
static void	initialize (const std::string &filename="", const std::string &output_filename="", const ParameterHandler::OutputStyle output_style_for_output_filename=ParameterHandler::Short, ParameterHandler &prm=ParameterAcceptor::prm, const ParameterHandler::OutputStyle output_style_for_filename=ParameterHandler::DefaultStyle)
static void	initialize (std::istream &input_stream, ParameterHandler &prm=ParameterAcceptor::prm)
static void	clear ()
static void	parse_all_parameters (ParameterHandler &prm=ParameterAcceptor::prm)
static void	declare_all_parameters (ParameterHandler &prm=ParameterAcceptor::prm)
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)
Static Public Member Functions inherited from EnableObserverPointer
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)
Static Public Attributes inherited from ParameterAcceptor
static ParameterHandler	prm
Protected Attributes inherited from ParameterAcceptor
const std::string	section_name
std::vector< std::string >	subsections

Detailed Description

template<int dim>
class ParticleCouplingParameters< dim >

Stores parameters related to particle coupling in a simulation.

This class inherits from ParameterAcceptor and provides parameters required for particle coupling algorithms, such as the extraction level for the R-tree structure.

Template Parameters

dim	The spatial dimension of the problem.

Definition at line 49 of file particle_coupling.h.

Constructor & Destructor Documentation

ParticleCouplingParameters()

template<int dim>

ParticleCouplingParameters< dim >::ParticleCouplingParameters

(

)

Constructor that initializes the parameters.

Definition at line 19 of file particle_coupling.cc.

References ParameterAcceptor::add_parameter(), ParameterAcceptor::ParameterAcceptor(), and rtree_extraction_level.

Member Data Documentation

rtree_extraction_level

template<int dim>

unsigned int ParticleCouplingParameters< dim >::rtree_extraction_level = 1

The level of the R-tree extraction.

This parameter controls the level of detail in the R-tree structure used for particle coupling. Higher values may lead to more accurate results but at the cost of increased computational complexity.

Definition at line 64 of file particle_coupling.h.

Referenced by ParticleCouplingParameters().

---

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

• /github/workspace/include/particle_coupling.h
• /github/workspace/source/particle_coupling.cc