SotParameterManager Class Reference

#include <ParameterManager.h>

Inheritance diagram for SotParameterManager:

Collaboration diagram for SotParameterManager:

Classes
struct	ConditionalDensityParameters
struct	MeshParameters
struct	MultilevelParameters
struct	PowerDiagramParameters
struct	SolverParameters
struct	TransportMapParameters

Public Member Functions
	SotParameterManager (const MPI_Comm &comm)
const MeshParameters &	get_source_params () const
const MeshParameters &	get_target_params () const
const SolverParameters &	get_solver_params () const
const MultilevelParameters &	get_multilevel_params () const
const PowerDiagramParameters &	get_power_diagram_params () const
const TransportMapParameters &	get_transport_map_params () const
const ConditionalDensityParameters &	get_conditional_density_params () const
const MPI_Comm &	get_mpi_communicator () const
const ConditionalOStream &	get_pcout () const
void	print_logo () const
virtual void	print_parameters () const

Public Attributes
MeshParameters &	source_params
MeshParameters &	target_params
SolverParameters &	solver_params
MultilevelParameters &	multilevel_params
PowerDiagramParameters &	power_diagram_params
TransportMapParameters &	transport_map_params
ConditionalDensityParameters &	conditional_density_params
std::string &	selected_task
std::string &	io_coding

Protected Member Functions
void	print_mesh_parameters () const
void	print_solver_parameters () const
void	print_multilevel_parameters () const
void	print_power_diagram_parameters () const
void	print_transport_map_parameters () const
void	print_conditional_density_parameters () const
void	print_task_information () const
void	print_section_header (const std::string &section_name) const

Protected Attributes
MPI_Comm	mpi_communicator
const unsigned int	n_mpi_processes
const unsigned int	this_mpi_process
ConditionalOStream	pcout

Private Attributes
std::string	selected_task_storage
std::string	io_coding_storage = "txt"
MeshParameters	source_params_storage
MeshParameters	target_params_storage
SolverParameters	solver_params_storage
MultilevelParameters	multilevel_params_storage
PowerDiagramParameters	power_diagram_params_storage
TransportMapParameters	transport_map_params_storage
ConditionalDensityParameters	conditional_density_params_storage

Detailed Description

A class to manage all parameters for the RSOT solver. This class handles parameter declaration, storage, and access for all components of the solver, including mesh generation, solver settings, and multilevel methods. It inherits from ParameterAcceptor to integrate with deal.II's parameter handling system.

Definition at line 29 of file ParameterManager.h.

Constructor & Destructor Documentation

SotParameterManager()

SotParameterManager::SotParameterManager

(

const MPI_Comm &

comm

)

Constructor.

Parameters

comm	MPI communicator for parallel execution

Definition at line 4 of file ParameterManager.cc.

Member Function Documentation

get_source_params()

const MeshParameters & SotParameterManager::get_source_params ( ) const

inline

Definition at line 124 of file ParameterManager.h.

get_target_params()

const MeshParameters & SotParameterManager::get_target_params ( ) const

inline

Definition at line 125 of file ParameterManager.h.

get_solver_params()

const SolverParameters & SotParameterManager::get_solver_params ( ) const

inline

Definition at line 126 of file ParameterManager.h.

get_multilevel_params()

const MultilevelParameters & SotParameterManager::get_multilevel_params ( ) const

inline

Definition at line 127 of file ParameterManager.h.

get_power_diagram_params()

const PowerDiagramParameters & SotParameterManager::get_power_diagram_params ( ) const

inline

Definition at line 128 of file ParameterManager.h.

get_transport_map_params()

const TransportMapParameters & SotParameterManager::get_transport_map_params ( ) const

inline

Definition at line 129 of file ParameterManager.h.

get_conditional_density_params()

const ConditionalDensityParameters & SotParameterManager::get_conditional_density_params ( ) const

inline

Definition at line 130 of file ParameterManager.h.

get_mpi_communicator()

const MPI_Comm & SotParameterManager::get_mpi_communicator ( ) const

inline

Definition at line 144 of file ParameterManager.h.

get_pcout()

const ConditionalOStream & SotParameterManager::get_pcout ( ) const

inline

Definition at line 145 of file ParameterManager.h.

print_logo()

void SotParameterManager::print_logo

(

)

const

Print all relevant parameters based on the selected task. This provides a comprehensive view of the current parameter settings.

Definition at line 161 of file ParameterManager.cc.

Here is the caller graph for this function:

print_parameters()

void SotParameterManager::print_parameters ( ) const

virtual

Reimplemented in LloydParameterManager.

Definition at line 191 of file ParameterManager.cc.

Here is the call graph for this function:

print_mesh_parameters()

void SotParameterManager::print_mesh_parameters ( ) const

protected

Definition at line 292 of file ParameterManager.cc.

Here is the caller graph for this function:

print_solver_parameters()

void SotParameterManager::print_solver_parameters ( ) const

protected

Definition at line 311 of file ParameterManager.cc.

Here is the caller graph for this function:

print_multilevel_parameters()

void SotParameterManager::print_multilevel_parameters ( ) const

protected

Definition at line 341 of file ParameterManager.cc.

Here is the caller graph for this function:

print_power_diagram_parameters()

void SotParameterManager::print_power_diagram_parameters ( ) const

protected

Definition at line 377 of file ParameterManager.cc.

Here is the caller graph for this function:

print_transport_map_parameters()

void SotParameterManager::print_transport_map_parameters ( ) const

protected

Definition at line 384 of file ParameterManager.cc.

Here is the caller graph for this function:

print_conditional_density_parameters()

void SotParameterManager::print_conditional_density_parameters ( ) const

protected

Definition at line 392 of file ParameterManager.cc.

Here is the caller graph for this function:

print_task_information()

void SotParameterManager::print_task_information ( ) const

protected

Definition at line 252 of file ParameterManager.cc.

Here is the caller graph for this function:

print_section_header()

void SotParameterManager::print_section_header ( const std::string &  section_name ) const

protected

Definition at line 246 of file ParameterManager.cc.

Here is the caller graph for this function:

Member Data Documentation

source_params

MeshParameters& SotParameterManager::source_params

Definition at line 133 of file ParameterManager.h.

target_params

MeshParameters& SotParameterManager::target_params

Definition at line 134 of file ParameterManager.h.

solver_params

SolverParameters& SotParameterManager::solver_params

Definition at line 135 of file ParameterManager.h.

multilevel_params

MultilevelParameters& SotParameterManager::multilevel_params

Definition at line 136 of file ParameterManager.h.

power_diagram_params

PowerDiagramParameters& SotParameterManager::power_diagram_params

Definition at line 137 of file ParameterManager.h.

transport_map_params

TransportMapParameters& SotParameterManager::transport_map_params

Definition at line 138 of file ParameterManager.h.

conditional_density_params

ConditionalDensityParameters& SotParameterManager::conditional_density_params

Definition at line 139 of file ParameterManager.h.

selected_task

std::string& SotParameterManager::selected_task

Definition at line 140 of file ParameterManager.h.

io_coding

std::string& SotParameterManager::io_coding

Definition at line 141 of file ParameterManager.h.

mpi_communicator

MPI_Comm SotParameterManager::mpi_communicator

protected

Definition at line 155 of file ParameterManager.h.

n_mpi_processes

const unsigned int SotParameterManager::n_mpi_processes

protected

Definition at line 156 of file ParameterManager.h.

this_mpi_process

const unsigned int SotParameterManager::this_mpi_process

protected

Definition at line 157 of file ParameterManager.h.

pcout

ConditionalOStream SotParameterManager::pcout

protected

Definition at line 158 of file ParameterManager.h.

selected_task_storage

std::string SotParameterManager::selected_task_storage

private

Definition at line 173 of file ParameterManager.h.

io_coding_storage

std::string SotParameterManager::io_coding_storage = "txt"

private

Definition at line 174 of file ParameterManager.h.

source_params_storage

MeshParameters SotParameterManager::source_params_storage

private

Definition at line 175 of file ParameterManager.h.

target_params_storage

MeshParameters SotParameterManager::target_params_storage

private

Definition at line 176 of file ParameterManager.h.

solver_params_storage

SolverParameters SotParameterManager::solver_params_storage

private

Definition at line 177 of file ParameterManager.h.

multilevel_params_storage

MultilevelParameters SotParameterManager::multilevel_params_storage

private

Definition at line 178 of file ParameterManager.h.

power_diagram_params_storage

PowerDiagramParameters SotParameterManager::power_diagram_params_storage

private

Definition at line 179 of file ParameterManager.h.

transport_map_params_storage

TransportMapParameters SotParameterManager::transport_map_params_storage

private

Definition at line 180 of file ParameterManager.h.

conditional_density_params_storage

ConditionalDensityParameters SotParameterManager::conditional_density_params_storage

private

Definition at line 181 of file ParameterManager.h.

---

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

• include/SemiDiscreteOT/utils/ParameterManager.h
• src/utils/ParameterManager.cc