SimulationFilmBoiling< dim, number > Class Template Reference

Developer Documentation: MeltPoolDG::Simulation::FilmBoiling::SimulationFilmBoiling< dim, number > Class Template Reference

Developer Documentation

#include <film_boiling.hpp>

Inheritance diagram for MeltPoolDG::Simulation::FilmBoiling::SimulationFilmBoiling< dim, number >:

[legend]

Collaboration diagram for MeltPoolDG::Simulation::FilmBoiling::SimulationFilmBoiling< dim, number >:

[legend]

Public Member Functions
	SimulationFilmBoiling (std::string parameter_file, const MPI_Comm mpi_communicator)

bool	add_case_specific_parameters (dealii::ParameterHandler &prm) override
	Add simulation-specific parameters (can be overridden).

void	create_spatial_discretization () override
	Pure virtual function to create the spatial discretization.

void	set_boundary_conditions () final
	Pure virtual function to set the boundary conditions.

void	set_field_conditions () final
	Pure virtual function to set the field conditions.

void	do_postprocessing (const GenericDataOut< dim, double > &generic_data_out) const final

Public Member Functions inherited from MeltPoolDG::MeltPoolCase< dim, number >
	MeltPoolCase (const std::string &parameter_file_in, MPI_Comm mpi_communicator_in)

Public Member Functions inherited from MeltPoolDG::SimulationCaseBase< dim, number, spacedim >
virtual	~SimulationCaseBase ()=default

	SimulationCaseBase (const std::string &parameter_file_in, MPI_Comm mpi_communicator_in)

void	create ()
	Main setup function to initialize the simulation.

std::map< dealii::types::boundary_id, std::shared_ptr< dealii::Function< dim > > >	get_boundary_condition (const std::string &type, const std::string &operation_name, const bool is_optional=true) const
	Retrieve boundary conditions of a specific type for an operation.

std::shared_ptr< BoundaryConditionManager< dim, number > >	get_boundary_condition_manager (const std::string &operation_name, const bool is_optional=true) const
	Retrieve the boundary condition object for a specific operation.

std::string	get_boundary_condition_type (dealii::types::boundary_id boundary_id, const std::string &operation_name) const
	Retrieve the type of a boundary condition for a specific boundary ID and operation.

void	set_time_boundary_conditions (const number time)
	Update the time for all boundary conditions.

std::shared_ptr< dealii::Function< dim > >	get_field_function (const std::string &type, const std::string &operation_name, const bool is_optional=false)

std::shared_ptr< dealii::Function< dim > >	get_initial_condition (const std::string &operation_name, const bool is_optional=false)
	Retrieve the initial condition for a given operation.

const PeriodicBoundaryConditions< dim > &	get_periodic_bc () const
	Get the periodic boundary condition manager.

virtual void	do_postprocessing (const GenericDataOut< dim, number > &generic_data_out) const
	Perform specific postprocessing (can be overridden by derived classes).

Private Attributes
const double	lambda0 = 0.0

const double	x_max

double	y_max

const double	x_min

const double	y_min = 0.0

unsigned int	n_written_time_step = 0

dealii::parallel::distributed::Triangulation< 2, 3 >	tria_slice

std::shared_ptr< PostProcessingTools::SliceCreator< 3, double > >	slice

Additional Inherited Members
Public Attributes inherited from MeltPoolDG::MeltPoolCase< dim, number >
MeltPoolCaseParameters< number >	parameters

Public Attributes inherited from MeltPoolDG::SimulationCaseBase< dim, number, spacedim >
std::shared_ptr< dealii::Triangulation< dim, spacedim > >	triangulation

const std::string	parameter_file

const MPI_Comm	mpi_communicator

Protected Member Functions inherited from MeltPoolDG::SimulationCaseBase< dim, number, spacedim >
void	attach_field_function (std::shared_ptr< dealii::Function< dim > > function, const std::string &type, const std::string &operation_name)

void	attach_initial_condition (std::shared_ptr< dealii::Function< dim > > initial_function, const std::string &operation_name)

void	attach_boundary_condition (std::pair< const dealii::types::boundary_id, const std::shared_ptr< dealii::Function< dim > > > id_and_function, const std::string &type, const std::string &operation_name)
	Attach a boundary condition for a specific operation.

void	attach_boundary_condition (const dealii::types::boundary_id id, const std::string &type, const std::string &operation_name)
	Attach a boundary condition with a dummy function for a specific operation.

void	attach_periodic_boundary_condition (const dealii::types::boundary_id id_in, const dealii::types::boundary_id id_out, const int direction)

Detailed Description

template<int dim, typename number>
class MeltPoolDG::Simulation::FilmBoiling::SimulationFilmBoiling< dim, number >

This class collects all relevant input data for the simulation.

Constructor & Destructor Documentation

◆ SimulationFilmBoiling()

template<int dim, typename number >

MeltPoolDG::Simulation::FilmBoiling::SimulationFilmBoiling< dim, number >::SimulationFilmBoiling	(	std::string	parameter_file,
		const MPI_Comm	mpi_communicator
	)

inline

Member Function Documentation

◆ add_case_specific_parameters()

template<int dim, typename number >

bool MeltPoolDG::Simulation::FilmBoiling::SimulationFilmBoiling< dim, number >::add_case_specific_parameters ( dealii::ParameterHandler & )

inlineoverridevirtual

Add simulation-specific parameters (can be overridden).

This function can be overridden in derived classes to add custom simulation parameters to the handler. The return value can be used to print the parameters to the terminal output.

Parameters

prm	ParameterHandler object to which parameters can be added.

Reimplemented from MeltPoolDG::SimulationCaseBase< dim, number, spacedim >.

◆ create_spatial_discretization()

template<int dim, typename number >

void MeltPoolDG::Simulation::FilmBoiling::SimulationFilmBoiling< dim, number >::create_spatial_discretization ( )

inlineoverridevirtual

Pure virtual function to create the spatial discretization.

Derived classes must implement this function to define how the spatial discretization is created.

Implements MeltPoolDG::SimulationCaseBase< dim, number, spacedim >.

◆ do_postprocessing()

template<int dim, typename number >

void MeltPoolDG::Simulation::FilmBoiling::SimulationFilmBoiling< dim, number >::do_postprocessing ( const GenericDataOut< dim, double > & generic_data_out ) const

inlinefinal

◆ set_boundary_conditions()

template<int dim, typename number >

void MeltPoolDG::Simulation::FilmBoiling::SimulationFilmBoiling< dim, number >::set_boundary_conditions ( )

inlinefinalvirtual

Pure virtual function to set the boundary conditions.

Derived classes must implement this function to define how boundary conditions are set.

Implements MeltPoolDG::SimulationCaseBase< dim, number, spacedim >.

◆ set_field_conditions()

template<int dim, typename number >

void MeltPoolDG::Simulation::FilmBoiling::SimulationFilmBoiling< dim, number >::set_field_conditions ( )

inlinefinalvirtual

Pure virtual function to set the field conditions.

Derived classes must implement this function to define how field conditions are set.

Implements MeltPoolDG::SimulationCaseBase< dim, number, spacedim >.

Member Data Documentation

◆ lambda0

template<int dim, typename number >

const double MeltPoolDG::Simulation::FilmBoiling::SimulationFilmBoiling< dim, number >::lambda0 = 0.0

private

◆ n_written_time_step

template<int dim, typename number >

unsigned int MeltPoolDG::Simulation::FilmBoiling::SimulationFilmBoiling< dim, number >::n_written_time_step = 0

mutableprivate

◆ slice

template<int dim, typename number >

std::shared_ptr<PostProcessingTools::SliceCreator<3, double> > MeltPoolDG::Simulation::FilmBoiling::SimulationFilmBoiling< dim, number >::slice

mutableprivate

◆ tria_slice

template<int dim, typename number >

dealii::parallel::distributed::Triangulation<2, 3> MeltPoolDG::Simulation::FilmBoiling::SimulationFilmBoiling< dim, number >::tria_slice

private

◆ x_max

template<int dim, typename number >

const double MeltPoolDG::Simulation::FilmBoiling::SimulationFilmBoiling< dim, number >::x_max

private

◆ x_min

template<int dim, typename number >

const double MeltPoolDG::Simulation::FilmBoiling::SimulationFilmBoiling< dim, number >::x_min

private

◆ y_max

template<int dim, typename number >

double MeltPoolDG::Simulation::FilmBoiling::SimulationFilmBoiling< dim, number >::y_max

private

◆ y_min

template<int dim, typename number >

const double MeltPoolDG::Simulation::FilmBoiling::SimulationFilmBoiling< dim, number >::y_min = 0.0

private

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

applications/mp-melt-pool/cases/film_boiling/film_boiling.hpp

SimulationFilmBoiling&lt; dim, number &gt; Class Template Reference

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SimulationFilmBoiling()

Member Function Documentation

◆ add_case_specific_parameters()

◆ create_spatial_discretization()

◆ do_postprocessing()

◆ set_boundary_conditions()

◆ set_field_conditions()

Member Data Documentation

◆ lambda0

◆ n_written_time_step

◆ slice

◆ tria_slice

◆ x_max

◆ x_min

◆ y_max

◆ y_min

SimulationFilmBoiling< dim, number > Class Template Reference