adamantine::BeamHeatSourceProperties Class Reference

#include <BeamHeatSourceProperties.hh>

Public Member Functions
	BeamHeatSourceProperties ()=default
	BeamHeatSourceProperties (boost::property_tree::ptree const &beam_database, boost::optional< boost::property_tree::ptree const & > const &units_optional_database)
void	set_from_database (boost::property_tree::ptree const &database)

Public Attributes
double	depth = 0.
double	absorption_efficiency = 0.
double	radius = 0.
double	radius_squared = 0.
double	max_power = 0.

Private Attributes
double	_dimension_scaling = 1.
double	_power_scaling = 1.

Detailed Description

This class stores all the physical properties necessary to define an beam heat source.

Definition at line 20 of file BeamHeatSourceProperties.hh.

Constructor & Destructor Documentation

BeamHeatSourceProperties() [1/2]

adamantine::BeamHeatSourceProperties::BeamHeatSourceProperties ( )

default

BeamHeatSourceProperties() [2/2]

adamantine::BeamHeatSourceProperties::BeamHeatSourceProperties ( boost::property_tree::ptree const &  beam_database, boost::optional< boost::property_tree::ptree const & > const &  units_optional_database  )

inline

Constructor.

Parameters

[in]	beam_database	requires the following entries: absorption_efficiency: double in depth: double in diameter: double in max_power: double in
[in]	units_optional_database	can have the following entries: heat_source.dimension heat_source.power

Definition at line 36 of file BeamHeatSourceProperties.hh.

Member Function Documentation

set_from_database()

void adamantine::BeamHeatSourceProperties::set_from_database ( boost::property_tree::ptree const &  database )

inline

Definition at line 55 of file BeamHeatSourceProperties.hh.

Member Data Documentation

_dimension_scaling

double adamantine::BeamHeatSourceProperties::_dimension_scaling = 1.

private

Scaling factor for the dimension of the heat source.

Definition at line 94 of file BeamHeatSourceProperties.hh.

_power_scaling

double adamantine::BeamHeatSourceProperties::_power_scaling = 1.

private

Scaling factor for the power of the heat source.

Definition at line 98 of file BeamHeatSourceProperties.hh.

absorption_efficiency

double adamantine::BeamHeatSourceProperties::absorption_efficiency = 0.

Energy conversion efficiency on the surface.

Definition at line 76 of file BeamHeatSourceProperties.hh.

depth

double adamantine::BeamHeatSourceProperties::depth = 0.

A metric of the depth of the heat source into the material. The specific definition of the depth may differ across heat source types.

Definition at line 72 of file BeamHeatSourceProperties.hh.

max_power

double adamantine::BeamHeatSourceProperties::max_power = 0.

Maximum power of the beam.

Definition at line 88 of file BeamHeatSourceProperties.hh.

radius

double adamantine::BeamHeatSourceProperties::radius = 0.

Beam radius.

Definition at line 80 of file BeamHeatSourceProperties.hh.

radius_squared

double adamantine::BeamHeatSourceProperties::radius_squared = 0.

Square of the beam radius.

Definition at line 84 of file BeamHeatSourceProperties.hh.