phoxonics::core::EngineBase Class Reference

Inheritance diagram for phoxonics::core::EngineBase:

Collaboration diagram for phoxonics::core::EngineBase:

Public Member Functions
	EngineBase ()
virtual	~EngineBase ()
virtual void	configure () override
virtual void	print_me () override
virtual void	start (std::shared_ptr< GridBase > grid_base, std::vector< std::shared_ptr< SourceBase >> sources_base, std::vector< std::shared_ptr< DetectorBase >> detectors_base, std::shared_ptr< PmlBase > pml_base)
	EngineBase ()
virtual	~EngineBase ()
virtual void	configure () override
virtual void	print_me () override
virtual void	start (std::shared_ptr< GridBase > grid_base, std::vector< std::shared_ptr< SourceBase >> sources_base, std::vector< std::shared_ptr< DetectorBase >> detectors_base, std::shared_ptr< PmlBase > pml_base)
Public Member Functions inherited from phoxonics::core::SimulationItemBase
virtual void	configure (std::shared_ptr< ConfigBase > config_base)
virtual void	configure (std::shared_ptr< ConfigBase > config_base)

Public Attributes
bool	mpi_enabled { false }
bool	cuda_enabled { false }
std::string	h5_geometry_file { "" }
std::string	h5_data_file { "" }
std::string	h5_geom_dataset_name { "" }
std::string	h5_data_dataset_name { "" }
bool	real_time_visualization { false }
std::string	visualization_commands { "" }
bool	generate_animation { false }
Public Attributes inherited from phoxonics::core::SimulationItemBase
std::shared_ptr< SimulationConfig >	sim_config { nullptr }

Protected Member Functions
virtual void	process ()
virtual void	update_field (std::string component)
virtual void	apply_sources (double time)
virtual void	apply_pml ()
virtual void	apply_detectors (double time)
virtual void	init_hdf5_files ()
virtual void	record_hdf5_slice ()
virtual void	visualize_real_time ()
virtual void	calculate_detectors_amp_phase ()
virtual void	record_hdf5_detectors ()
virtual void	generate_hdf5_shell (bool execute_shell)
std::string	h5_component_data_file (std::string component)
virtual void	process ()
virtual void	update_field (std::string component)
virtual void	apply_sources (double time)
virtual void	apply_pml ()
virtual void	apply_detectors (double time)
virtual void	init_hdf5_files ()
virtual void	record_hdf5_slice ()
virtual void	visualize_real_time ()
virtual void	calculate_detectors_amp_phase ()
virtual void	record_hdf5_detectors ()
virtual void	generate_hdf5_shell (bool execute_shell)
std::string	h5_component_data_file (std::string component)
Protected Member Functions inherited from phoxonics::core::SimulationItemBase
	SimulationItemBase ()
virtual	~SimulationItemBase ()
	SimulationItemBase ()
virtual	~SimulationItemBase ()

Protected Attributes
std::shared_ptr< GridBase >	grid_base_
std::vector< std::shared_ptr < SourceBase > >	sources_base_
std::vector< std::shared_ptr < DetectorBase > >	detectors_base_
std::shared_ptr< PmlBase >	pml_base_
Protected Attributes inherited from phoxonics::core::SimulationItemBase
phoxonics::common::Logger	log_
ConfigParamHelper	config_param_heleper_
EmConstants	em_constants_
phoxonics::common::Folder	fld_
phoxonics::common::Utilities	utils_
phoxonics::common::Strings	strs_
phoxonics::visual::Hdf5Renderer	hdf5_renderer_
phoxonics::common::Config	cfg_

Additional Inherited Members
Protected Types inherited from phoxonics::core::SimulationItemBase
typedef phoxonics::common::Formatter	fmt_
typedef phoxonics::common::Formatter	fmt_

Constructor & Destructor Documentation

phoxonics::core::EngineBase::EngineBase ( )

explicit

References phoxonics::core::SimulationItemBase::log_, and phoxonics::common::Logger::log_trac().

phoxonics::core::EngineBase::~EngineBase ( )

virtual

References phoxonics::core::SimulationItemBase::log_, and phoxonics::common::Logger::log_trac().

phoxonics::core::EngineBase::EngineBase ( )

explicit

virtual phoxonics::core::EngineBase::~EngineBase ( )

virtual

Member Function Documentation

void phoxonics::core::EngineBase::apply_detectors ( double  time )

protectedvirtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, phoxonics::core::ElectroMagnetic2D, and phoxonics::core::ElectroMagnetic1D.

References phoxonics::core::SimulationItemBase::log_, and phoxonics::common::Logger::log_trac().

virtual void phoxonics::core::EngineBase::apply_detectors ( double  time )

protectedvirtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, phoxonics::core::ElectroMagnetic2D, and phoxonics::core::ElectroMagnetic1D.

void phoxonics::core::EngineBase::apply_pml ( )

protectedvirtual

Reimplemented in phoxonics::core::ElectroMagnetic1D.

References phoxonics::core::SimulationItemBase::log_, and phoxonics::common::Logger::log_trac().

virtual void phoxonics::core::EngineBase::apply_pml ( )

protectedvirtual

Reimplemented in phoxonics::core::ElectroMagnetic1D.

virtual void phoxonics::core::EngineBase::apply_sources ( double  time )

protectedvirtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, phoxonics::core::ElectroMagnetic2D, and phoxonics::core::ElectroMagnetic1D.

void phoxonics::core::EngineBase::apply_sources ( double  time )

protectedvirtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, phoxonics::core::ElectroMagnetic2D, and phoxonics::core::ElectroMagnetic1D.

References phoxonics::core::SimulationItemBase::log_, and phoxonics::common::Logger::log_trac().

void phoxonics::core::EngineBase::calculate_detectors_amp_phase ( )

protectedvirtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, and phoxonics::core::ElectroMagnetic2D.

References phoxonics::core::SimulationItemBase::log_, and phoxonics::common::Logger::log_trac().

virtual void phoxonics::core::EngineBase::calculate_detectors_amp_phase ( )

protectedvirtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, and phoxonics::core::ElectroMagnetic2D.

virtual void phoxonics::core::EngineBase::configure ( )

overridevirtual

Reimplemented from phoxonics::core::SimulationItemBase.

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, phoxonics::core::ElectroMagnetic2D, and phoxonics::core::ElectroMagnetic1D.

void phoxonics::core::EngineBase::configure ( )

overridevirtual

Reimplemented from phoxonics::core::SimulationItemBase.

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, phoxonics::core::ElectroMagnetic2D, and phoxonics::core::ElectroMagnetic1D.

References phoxonics::core::SimulationItemBase::configure(), cuda_enabled, generate_animation, h5_data_dataset_name, h5_data_file, h5_geom_dataset_name, h5_geometry_file, phoxonics::core::SimulationItemBase::log_, phoxonics::common::Logger::log_trac(), mpi_enabled, real_time_visualization, phoxonics::core::SimulationItemBase::sim_config, and visualization_commands.

Referenced by phoxonics::core::ElectroMagnetic1D::configure(), phoxonics::core::ElectroMagnetic2D::configure(), and phoxonics::core::PhxElectroMagnetic2D::configure().

virtual void phoxonics::core::EngineBase::generate_hdf5_shell ( bool  execute_shell )

protectedvirtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, and phoxonics::core::ElectroMagnetic2D.

void phoxonics::core::EngineBase::generate_hdf5_shell ( bool  execute_shell )

protectedvirtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, and phoxonics::core::ElectroMagnetic2D.

References phoxonics::core::SimulationItemBase::log_, and phoxonics::common::Logger::log_trac().

std::string phoxonics::core::EngineBase::h5_component_data_file ( std::string  component )

protected

std::string phoxonics::core::EngineBase::h5_component_data_file ( std::string  component )

protected

References h5_data_file, phoxonics::core::SimulationItemBase::log_, phoxonics::common::Logger::log_trac(), phoxonics::common::Strings::replace(), and phoxonics::core::SimulationItemBase::strs_.

void phoxonics::core::EngineBase::init_hdf5_files ( )

protectedvirtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, and phoxonics::core::ElectroMagnetic2D.

References phoxonics::core::SimulationItemBase::log_, and phoxonics::common::Logger::log_trac().

virtual void phoxonics::core::EngineBase::init_hdf5_files ( )

protectedvirtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, and phoxonics::core::ElectroMagnetic2D.

virtual void phoxonics::core::EngineBase::print_me ( )

overridevirtual

Reimplemented from phoxonics::core::SimulationItemBase.

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, phoxonics::core::ElectroMagnetic2D, and phoxonics::core::ElectroMagnetic1D.

void phoxonics::core::EngineBase::print_me ( )

overridevirtual

Reimplemented from phoxonics::core::SimulationItemBase.

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, phoxonics::core::ElectroMagnetic2D, and phoxonics::core::ElectroMagnetic1D.

References cuda_enabled, h5_data_dataset_name, h5_data_file, h5_geom_dataset_name, h5_geometry_file, phoxonics::core::SimulationItemBase::log_, phoxonics::common::Logger::log_info(), phoxonics::common::Logger::log_trac(), mpi_enabled, phoxonics::core::SimulationItemBase::print_me(), real_time_visualization, and visualization_commands.

Referenced by phoxonics::core::ElectroMagnetic1D::print_me(), phoxonics::core::ElectroMagnetic2D::print_me(), and phoxonics::core::PhxElectroMagnetic2D::print_me().

virtual void phoxonics::core::EngineBase::process ( )

protectedvirtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, phoxonics::core::ElectroMagnetic2D, and phoxonics::core::ElectroMagnetic1D.

void phoxonics::core::EngineBase::process ( )

protectedvirtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, phoxonics::core::ElectroMagnetic2D, and phoxonics::core::ElectroMagnetic1D.

References phoxonics::core::SimulationItemBase::log_, and phoxonics::common::Logger::log_trac().

void phoxonics::core::EngineBase::record_hdf5_detectors ( )

protectedvirtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, and phoxonics::core::ElectroMagnetic2D.

References phoxonics::core::SimulationItemBase::log_, and phoxonics::common::Logger::log_trac().

virtual void phoxonics::core::EngineBase::record_hdf5_detectors ( )

protectedvirtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, and phoxonics::core::ElectroMagnetic2D.

void phoxonics::core::EngineBase::record_hdf5_slice ( )

protectedvirtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, and phoxonics::core::ElectroMagnetic2D.

References phoxonics::core::SimulationItemBase::log_, and phoxonics::common::Logger::log_trac().

virtual void phoxonics::core::EngineBase::record_hdf5_slice ( )

protectedvirtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, and phoxonics::core::ElectroMagnetic2D.

void phoxonics::core::EngineBase::start ( std::shared_ptr< GridBase >  grid_base, std::vector< std::shared_ptr< SourceBase >>  sources_base, std::vector< std::shared_ptr< DetectorBase >>  detectors_base, std::shared_ptr< PmlBase >  pml_base  )

virtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, phoxonics::core::ElectroMagnetic2D, and phoxonics::core::ElectroMagnetic1D.

References detectors_base_, grid_base_, phoxonics::core::SimulationItemBase::log_, phoxonics::common::Logger::log_trac(), pml_base_, and sources_base_.

Referenced by phoxonics::core::ElectroMagnetic1D::start(), phoxonics::core::ElectroMagnetic2D::start(), and phoxonics::core::PhxElectroMagnetic2D::start().

virtual void phoxonics::core::EngineBase::start ( std::shared_ptr< GridBase >  grid_base, std::vector< std::shared_ptr< SourceBase >>  sources_base, std::vector< std::shared_ptr< DetectorBase >>  detectors_base, std::shared_ptr< PmlBase >  pml_base  )

virtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, phoxonics::core::ElectroMagnetic2D, and phoxonics::core::ElectroMagnetic1D.

void phoxonics::core::EngineBase::update_field ( std::string  component )

protectedvirtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, phoxonics::core::ElectroMagnetic2D, and phoxonics::core::ElectroMagnetic1D.

References phoxonics::core::SimulationItemBase::log_, and phoxonics::common::Logger::log_trac().

virtual void phoxonics::core::EngineBase::update_field ( std::string  component )

protectedvirtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, phoxonics::core::ElectroMagnetic2D, and phoxonics::core::ElectroMagnetic1D.

void phoxonics::core::EngineBase::visualize_real_time ( )

protectedvirtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, and phoxonics::core::ElectroMagnetic2D.

References phoxonics::core::SimulationItemBase::log_, and phoxonics::common::Logger::log_trac().

virtual void phoxonics::core::EngineBase::visualize_real_time ( )

protectedvirtual

Reimplemented in phoxonics::core::PhxElectroMagnetic2D, and phoxonics::core::ElectroMagnetic2D.

Member Data Documentation

bool phoxonics::core::EngineBase::cuda_enabled { false }

Referenced by configure(), and print_me().

std::vector< std::shared_ptr< DetectorBase > > phoxonics::core::EngineBase::detectors_base_

protected

Referenced by phoxonics::core::ElectroMagnetic2D::apply_detectors(), phoxonics::core::PhxElectroMagnetic2D::apply_detectors(), phoxonics::core::ElectroMagnetic2D::calculate_detectors_amp_phase(), phoxonics::core::PhxElectroMagnetic2D::calculate_detectors_amp_phase(), phoxonics::core::PhxElectroMagnetic2D::generate_hdf5_shell(), phoxonics::core::ElectroMagnetic2D::record_hdf5_detectors(), phoxonics::core::PhxElectroMagnetic2D::record_hdf5_detectors(), and start().

bool phoxonics::core::EngineBase::generate_animation { false }

Referenced by configure(), phoxonics::core::ElectroMagnetic2D::process(), and phoxonics::core::PhxElectroMagnetic2D::process().

std::shared_ptr< GridBase > phoxonics::core::EngineBase::grid_base_

protected

Referenced by phoxonics::core::ElectroMagnetic2D::apply_detectors(), phoxonics::core::PhxElectroMagnetic2D::apply_detectors(), phoxonics::core::ElectroMagnetic1D::apply_pml(), phoxonics::core::ElectroMagnetic1D::apply_sources(), phoxonics::core::ElectroMagnetic2D::apply_sources(), phoxonics::core::PhxElectroMagnetic2D::apply_sources(), phoxonics::core::ElectroMagnetic2D::record_hdf5_slice(), phoxonics::core::PhxElectroMagnetic2D::record_hdf5_slice(), start(), phoxonics::core::ElectroMagnetic1D::update_field(), phoxonics::core::ElectroMagnetic2D::update_field(), phoxonics::core::PhxElectroMagnetic2D::update_field(), phoxonics::core::ElectroMagnetic2D::visualize_real_time(), and phoxonics::core::PhxElectroMagnetic2D::visualize_real_time().

std::string phoxonics::core::EngineBase::h5_data_dataset_name { "" }

Referenced by configure(), phoxonics::core::ElectroMagnetic2D::init_hdf5_files(), phoxonics::core::PhxElectroMagnetic2D::init_hdf5_files(), print_me(), and phoxonics::core::ElectroMagnetic1D::process().

std::string phoxonics::core::EngineBase::h5_data_file { "" }

Referenced by configure(), h5_component_data_file(), print_me(), and phoxonics::core::ElectroMagnetic1D::process().

std::string phoxonics::core::EngineBase::h5_geom_dataset_name { "" }

Referenced by configure(), and print_me().

std::string phoxonics::core::EngineBase::h5_geometry_file { "" }

Referenced by configure(), and print_me().

bool phoxonics::core::EngineBase::mpi_enabled { false }

Referenced by configure(), and print_me().

std::shared_ptr< PmlBase > phoxonics::core::EngineBase::pml_base_

protected

Referenced by phoxonics::core::ElectroMagnetic1D::apply_pml(), and start().

bool phoxonics::core::EngineBase::real_time_visualization { false }

Referenced by configure(), print_me(), phoxonics::core::ElectroMagnetic1D::process(), phoxonics::core::ElectroMagnetic2D::visualize_real_time(), and phoxonics::core::PhxElectroMagnetic2D::visualize_real_time().

std::vector< std::shared_ptr< SourceBase > > phoxonics::core::EngineBase::sources_base_

protected

Referenced by phoxonics::core::ElectroMagnetic1D::apply_sources(), phoxonics::core::ElectroMagnetic2D::apply_sources(), phoxonics::core::PhxElectroMagnetic2D::apply_sources(), and start().

std::string phoxonics::core::EngineBase::visualization_commands { "" }

Referenced by configure(), print_me(), phoxonics::core::ElectroMagnetic2D::visualize_real_time(), and phoxonics::core::PhxElectroMagnetic2D::visualize_real_time().