MeltPoolDG::Simulation::VortexBubbleDG::SimulationVortexBubbleDG< dim, number > Class Template Reference

#include <vortex_bubble_DG.hpp>

Inheritance diagram for MeltPoolDG::Simulation::VortexBubbleDG::SimulationVortexBubbleDG< dim, number >:

Collaboration diagram for MeltPoolDG::Simulation::VortexBubbleDG::SimulationVortexBubbleDG< dim, number >:

Public Member Functions
	SimulationVortexBubbleDG (std::string parameter_file, const MPI_Comm mpi_communicator)
void	create_spatial_discretization () override
	Pure virtual function to create the spatial discretization.
void	set_boundary_conditions () override
	Pure virtual function to set the boundary conditions.
void	set_field_conditions () override
	Pure virtual function to set the field conditions.
void	do_postprocessing (const GenericDataOut< dim, number > &generic_data_out) const final
	Perform specific postprocessing (can be overridden by derived classes).
bool	add_case_specific_parameters (dealii::ParameterHandler &prm) override
	Add simulation-specific parameters (can be overridden).
Public Member Functions inherited from MeltPoolDG::LevelSet::LevelSetCase< dim, number >
	LevelSetCase (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.

Private Attributes
number	left_domain = 0.0
number	right_domain = 1.0
dealii::TableHandler	table

Additional Inherited Members
Public Attributes inherited from MeltPoolDG::LevelSet::LevelSetCase< dim, number >
LevelSetCaseParameters< 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)

Constructor & Destructor Documentation

SimulationVortexBubbleDG()

template<int dim, typename number >

MeltPoolDG::Simulation::VortexBubbleDG::SimulationVortexBubbleDG< dim, number >::SimulationVortexBubbleDG ( 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::VortexBubbleDG::SimulationVortexBubbleDG< 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::VortexBubbleDG::SimulationVortexBubbleDG< 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::VortexBubbleDG::SimulationVortexBubbleDG< dim, number >::do_postprocessing ( const GenericDataOut< dim, number > &  generic_data_out ) const

inlinefinalvirtual

Perform specific postprocessing (can be overridden by derived classes).

Note

This function needs to be called within the specific application.

Parameters

generic_data_out

The postprocessing data.

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

set_boundary_conditions()

template<int dim, typename number >

void MeltPoolDG::Simulation::VortexBubbleDG::SimulationVortexBubbleDG< dim, number >::set_boundary_conditions ( )

inlineoverridevirtual

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::VortexBubbleDG::SimulationVortexBubbleDG< dim, number >::set_field_conditions ( )

inlineoverridevirtual

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

left_domain

template<int dim, typename number >

number MeltPoolDG::Simulation::VortexBubbleDG::SimulationVortexBubbleDG< dim, number >::left_domain = 0.0

private

right_domain

template<int dim, typename number >

number MeltPoolDG::Simulation::VortexBubbleDG::SimulationVortexBubbleDG< dim, number >::right_domain = 1.0

private

table

template<int dim, typename number >

dealii::TableHandler MeltPoolDG::Simulation::VortexBubbleDG::SimulationVortexBubbleDG< dim, number >::table

mutableprivate

---

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

• applications/mp-level-set/cases/vortex_bubble_DG.hpp