BioCMAMC-ST
Core::SimulationUnitBuilder Class Reference

#include <simulation_builder.hpp>

Collaboration diagram for Core::SimulationUnitBuilder:
[legend]

Public Member Functions

 SimulationUnitBuilder ()=default
 ~SimulationUnitBuilder ()=default
 SimulationUnitBuilder (const SimulationUnitBuilder &)=delete
SimulationUnitBuilderoperator= (const SimulationUnitBuilder &)=delete
 SimulationUnitBuilder (SimulationUnitBuilder &&)=default
SimulationUnitBuilderoperator= (SimulationUnitBuilder &&)=default
SimulationUnitBuilder with_unit (std::unique_ptr< MC::MonteCarloUnit > &&unit)
SimulationUnitBuilder with_scalar (Simulation::ScalarInitializer &&scalar_init)
SimulationUnitBuilder with_specie_table (std::shared_ptr< Mixture::SpecieTable > specie_table)
SimulationUnitBuilder with_params (Simulation::Sparam params)
SimulationUnitBuilder with_mt_model (std::optional< Simulation::MassTransfer::Type::MtrTypeVariant > &&mt_model_variant)
SimulationUnitBuilder with_feed (Simulation::Feed::SimulationFeed feed)
Result< std::unique_ptr< Simulation::SimulationUnit >, BuildErrorbuild ()

Private Attributes

std::unique_ptr< MC::MonteCarloUnitm_unit
std::optional< Simulation::ScalarInitializerm_scalar_init
std::shared_ptr< Mixture::SpecieTablem_specie_table
std::optional< Simulation::MassTransfer::Type::MtrTypeVariantm_mt_model_variant
Simulation::Sparam m_params = Simulation::Sparam::fdefault()
std::optional< Simulation::Feed::SimulationFeedm_feed

Constructor & Destructor Documentation

◆ SimulationUnitBuilder() [1/3]

Core::SimulationUnitBuilder::SimulationUnitBuilder ( )
default
Here is the caller graph for this function:

◆ ~SimulationUnitBuilder()

Core::SimulationUnitBuilder::~SimulationUnitBuilder ( )
default

◆ SimulationUnitBuilder() [2/3]

Core::SimulationUnitBuilder::SimulationUnitBuilder ( const SimulationUnitBuilder & )
delete
Here is the call graph for this function:

◆ SimulationUnitBuilder() [3/3]

Core::SimulationUnitBuilder::SimulationUnitBuilder ( SimulationUnitBuilder && )
default
Here is the call graph for this function:

Member Function Documentation

◆ build()

Result< std::unique_ptr< Simulation::SimulationUnit >, BuildError > Core::SimulationUnitBuilder::build ( )
nodiscard
Here is the call graph for this function:

◆ operator=() [1/2]

SimulationUnitBuilder & Core::SimulationUnitBuilder::operator= ( const SimulationUnitBuilder & )
delete
Here is the call graph for this function:

◆ operator=() [2/2]

SimulationUnitBuilder & Core::SimulationUnitBuilder::operator= ( SimulationUnitBuilder && )
default
Here is the call graph for this function:

◆ with_feed()

SimulationUnitBuilder Core::SimulationUnitBuilder::with_feed ( Simulation::Feed::SimulationFeed feed)

◆ with_mt_model()

SimulationUnitBuilder Core::SimulationUnitBuilder::with_mt_model ( std::optional< Simulation::MassTransfer::Type::MtrTypeVariant > && mt_model_variant)

◆ with_params()

SimulationUnitBuilder Core::SimulationUnitBuilder::with_params ( Simulation::Sparam params)

◆ with_scalar()

SimulationUnitBuilder Core::SimulationUnitBuilder::with_scalar ( Simulation::ScalarInitializer && scalar_init)

◆ with_specie_table()

SimulationUnitBuilder Core::SimulationUnitBuilder::with_specie_table ( std::shared_ptr< Mixture::SpecieTable > specie_table)

◆ with_unit()

SimulationUnitBuilder Core::SimulationUnitBuilder::with_unit ( std::unique_ptr< MC::MonteCarloUnit > && unit)

Member Data Documentation

◆ m_feed

std::optional<Simulation::Feed::SimulationFeed> Core::SimulationUnitBuilder::m_feed
private

◆ m_mt_model_variant

std::optional<Simulation::MassTransfer::Type::MtrTypeVariant> Core::SimulationUnitBuilder::m_mt_model_variant
private

◆ m_params

Simulation::Sparam Core::SimulationUnitBuilder::m_params = Simulation::Sparam::fdefault()
private

◆ m_scalar_init

std::optional<Simulation::ScalarInitializer> Core::SimulationUnitBuilder::m_scalar_init
private

◆ m_specie_table

std::shared_ptr<Mixture::SpecieTable> Core::SimulationUnitBuilder::m_specie_table
private

◆ m_unit

std::unique_ptr<MC::MonteCarloUnit> Core::SimulationUnitBuilder::m_unit
private

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