MeltPoolDG::MeltPoolCaseParameters< number > Struct Template Reference

#include <melt_pool_case.hpp>

Inheritance diagram for MeltPoolDG::MeltPoolCaseParameters< number >:

Collaboration diagram for MeltPoolDG::MeltPoolCaseParameters< number >:

Public Attributes
BaseData	base
TimeIntegration::TimeSteppingData< number >	time_stepping
AdaptiveMeshingData< number >	amr
LevelSet::LevelSetData< number >	ls
Heat::HeatData< number >	heat
Heat::LaserData< number >	laser
RadiativeTransport::RadiativeTransportData< number >	rte
Flow::FlowData< number >	flow
Evaporation::EvaporationData< number >	evapor
MaterialData< number >	material
OutputData< number >	output
Profiling::ProfilingData< number >	profiling
Restart::RestartData< number >	restart
MeltFrontPropagationData< number >	melt_front
struct {
bool   do_heat_transfer = false
bool   do_solidification = false
bool   do_advect_level_set = true
bool   do_extrapolate_coupling_terms = false
struct {
int   n_max_iter = 1
number   tol = 1e-10
}   level_set_evapor_coupling
struct {
int   n_max_iter = 1
number   tol = 1e-10
}   heat_evapor_coupling
struct {
AMRStrategy   strategy = AMRStrategy::generic
AutomaticGridRefinementType   automatic_grid_refinement_type
bool   do_auto_detect_frequency = false
bool   do_refine_all_interface_cells = false
number   fraction_of_melting_point_refined_in_solid = 1.0
bool   refine_gas_domain = false
}   amr
struct {
number   time_step_size = -1
number   max_temperature = -1
number   max_change_factor_time_step_size = 1.5
}   mp_heat_up
}	application_specific_parameters

Protected Member Functions
void	add_parameters (dealii::ParameterHandler &prm) final
	Add parameters to the ParameterHandler.
void	post (const std::string &parameter_filename) final
	Post-processing after reading the parameter file.

Private Member Functions
void	check_input_parameters () const

Additional Inherited Members
Public Member Functions inherited from MeltPoolDG::ParametersBase
virtual void	process_parameters_file (dealii::ParameterHandler &prm, const std::string &parameter_filename)
	Process a parameter file and populate the ParameterHandler.
void	print_parameters (dealii::ParameterHandler &prm, std::ostream &pcout, const bool print_details)
	Print parameters to an output stream.
Protected Attributes inherited from MeltPoolDG::ParametersBase
bool	parameters_read = false

Detailed Description

template<typename number>
struct MeltPoolDG::MeltPoolCaseParameters< number >

Collection of all parameters of MeltPoolDG.

Warning

MeltPoolCaseParameters are read in order they are specified in the parameter files. We exploit this behavior, e.g, in MaterialData, to allow to set default parameters based on the user input and to override individual entries subsequently. Please don't sort your input files and if you do be aware that you might change the behavior!

Member Function Documentation

add_parameters()

template<typename number >

void MeltPoolDG::MeltPoolCaseParameters< number >::add_parameters ( dealii::ParameterHandler &  prm )

inlinefinalprotectedvirtual

Add parameters to the ParameterHandler.

Derived classes must implement this method to define the parameters managed by the ParameterHandler.

Parameters

prm	The ParameterHandler object where parameters will be added.

Implements MeltPoolDG::ParametersBase.

check_input_parameters()

template<typename number >

void MeltPoolDG::MeltPoolCaseParameters< number >::check_input_parameters ( ) const

inlineprivate

post()

template<typename number >

void MeltPoolDG::MeltPoolCaseParameters< number >::post ( const std::string &  parameter_filename )

inlinefinalprotectedvirtual

Post-processing after reading the parameter file.

This method is called after the parameter file has been parsed. Derived classes can override it to perform additional setup or validation based on the file contents.

Parameters

parameter_filename

The name of the parameter file that was processed.

Implements MeltPoolDG::ParametersBase.

Member Data Documentation

amr [1/2]

template<typename number >

AdaptiveMeshingData<number> MeltPoolDG::MeltPoolCaseParameters< number >::amr

[struct] [2/2]

struct { ... } MeltPoolDG::MeltPoolCaseParameters< number >::amr

[struct]

struct { ... } MeltPoolDG::MeltPoolCaseParameters< number >::application_specific_parameters

automatic_grid_refinement_type

template<typename number >

AutomaticGridRefinementType MeltPoolDG::MeltPoolCaseParameters< number >::automatic_grid_refinement_type

Initial value:

=
          AutomaticGridRefinementType::fixed_number

base

template<typename number >

BaseData MeltPoolDG::MeltPoolCaseParameters< number >::base

do_advect_level_set

template<typename number >

bool MeltPoolDG::MeltPoolCaseParameters< number >::do_advect_level_set = true

do_auto_detect_frequency

template<typename number >

bool MeltPoolDG::MeltPoolCaseParameters< number >::do_auto_detect_frequency = false

do_extrapolate_coupling_terms

template<typename number >

bool MeltPoolDG::MeltPoolCaseParameters< number >::do_extrapolate_coupling_terms = false

do_heat_transfer

template<typename number >

bool MeltPoolDG::MeltPoolCaseParameters< number >::do_heat_transfer = false

do_refine_all_interface_cells

template<typename number >

bool MeltPoolDG::MeltPoolCaseParameters< number >::do_refine_all_interface_cells = false

do_solidification

template<typename number >

bool MeltPoolDG::MeltPoolCaseParameters< number >::do_solidification = false

evapor

template<typename number >

Evaporation::EvaporationData<number> MeltPoolDG::MeltPoolCaseParameters< number >::evapor

flow

template<typename number >

Flow::FlowData<number> MeltPoolDG::MeltPoolCaseParameters< number >::flow

fraction_of_melting_point_refined_in_solid

template<typename number >

number MeltPoolDG::MeltPoolCaseParameters< number >::fraction_of_melting_point_refined_in_solid = 1.0

heat

template<typename number >

Heat::HeatData<number> MeltPoolDG::MeltPoolCaseParameters< number >::heat

[struct]

struct { ... } MeltPoolDG::MeltPoolCaseParameters< number >::heat_evapor_coupling

laser

template<typename number >

Heat::LaserData<number> MeltPoolDG::MeltPoolCaseParameters< number >::laser

[struct]

struct { ... } MeltPoolDG::MeltPoolCaseParameters< number >::level_set_evapor_coupling

ls

template<typename number >

LevelSet::LevelSetData<number> MeltPoolDG::MeltPoolCaseParameters< number >::ls

material

template<typename number >

MaterialData<number> MeltPoolDG::MeltPoolCaseParameters< number >::material

max_change_factor_time_step_size

template<typename number >

number MeltPoolDG::MeltPoolCaseParameters< number >::max_change_factor_time_step_size = 1.5

max_temperature

template<typename number >

number MeltPoolDG::MeltPoolCaseParameters< number >::max_temperature = -1

melt_front

template<typename number >

MeltFrontPropagationData<number> MeltPoolDG::MeltPoolCaseParameters< number >::melt_front

[struct]

struct { ... } MeltPoolDG::MeltPoolCaseParameters< number >::mp_heat_up

n_max_iter

template<typename number >

int MeltPoolDG::MeltPoolCaseParameters< number >::n_max_iter = 1

output

template<typename number >

OutputData<number> MeltPoolDG::MeltPoolCaseParameters< number >::output

profiling

template<typename number >

Profiling::ProfilingData<number> MeltPoolDG::MeltPoolCaseParameters< number >::profiling

refine_gas_domain

template<typename number >

bool MeltPoolDG::MeltPoolCaseParameters< number >::refine_gas_domain = false

restart

template<typename number >

Restart::RestartData<number> MeltPoolDG::MeltPoolCaseParameters< number >::restart

rte

template<typename number >

RadiativeTransport::RadiativeTransportData<number> MeltPoolDG::MeltPoolCaseParameters< number >::rte

strategy

template<typename number >

AMRStrategy MeltPoolDG::MeltPoolCaseParameters< number >::strategy = AMRStrategy::generic

time_step_size

template<typename number >

number MeltPoolDG::MeltPoolCaseParameters< number >::time_step_size = -1

time_stepping

template<typename number >

TimeIntegration::TimeSteppingData<number> MeltPoolDG::MeltPoolCaseParameters< number >::time_stepping

tol

template<typename number >

number MeltPoolDG::MeltPoolCaseParameters< number >::tol = 1e-10

---

The documentation for this struct was generated from the following file:

• applications/mp-melt-pool/melt_pool_case.hpp