Describing heat flux boundary conditions

Collaboration diagram for Describing heat flux boundary conditions:

Namespaces
	aspect::BoundaryHeatFlux

Classes
class	aspect::BoundaryHeatFlux::Function< dim >
class	aspect::BoundaryHeatFlux::Interface< dim >

Macros
#define	ASPECT_REGISTER_BOUNDARY_HEAT_FLUX_MODEL(classname, name, description)

Functions
template<int dim>
void	aspect::BoundaryHeatFlux::register_boundary_heat_flux (const std::string &name, const std::string &description, void(*declare_parameters_function)(ParameterHandler &), std::unique_ptr< Interface< dim >>(*factory_function)())
template<int dim>
std::unique_ptr< Interface< dim > >	aspect::BoundaryHeatFlux::create_boundary_heat_flux (ParameterHandler &prm)
template<int dim>
void	aspect::BoundaryHeatFlux::declare_parameters (ParameterHandler &prm)

Detailed Description

A module for the definition of functions and classes that have to do with describing heat flux boundary values for the temperature field.

Macro Definition Documentation

ASPECT_REGISTER_BOUNDARY_HEAT_FLUX_MODEL

#define ASPECT_REGISTER_BOUNDARY_HEAT_FLUX_MODEL	(		classname,
			name,
			description
	)

Value:

template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_BOUNDARY_HEAT_FLUX_MODEL_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::BoundaryHeatFlux::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::BoundaryHeatFlux::register_boundary_heat_flux<2>, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::BoundaryHeatFlux::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::BoundaryHeatFlux::register_boundary_heat_flux<3>, \
                                name, description); \
  }

Given a class name, a name, and a description for the parameter file for a boundary heat flux model, register it with the functions that can declare their parameters and create these objects.

Definition at line 153 of file interface.h.

Function Documentation

register_boundary_heat_flux()

template<int dim>

void aspect::BoundaryHeatFlux::register_boundary_heat_flux	(	const std::string &	name,
		const std::string &	description,
		void(*)(ParameterHandler &)	declare_parameters_function,
		std::unique_ptr< Interface< dim >>(*)()	factory_function
	)

Register a boundary heat flux model so that it can be selected from the parameter file.

Parameters

name	A string that identifies the fluid pressure boundary model
description	A text description of what this model does and that will be listed in the documentation of the parameter file.
declare_parameters_function	A pointer to a function that can be used to declare the parameters that this boundary heat flux model wants to read from input files.
factory_function	A pointer to a function that can create an object of this boundary heat flux model.

create_boundary_heat_flux()

template<int dim>

std::unique_ptr<Interface<dim> > aspect::BoundaryHeatFlux::create_boundary_heat_flux

(

ParameterHandler &

prm

)

A function that given the name of a model returns a pointer to an object that describes it. Ownership of the pointer is transferred to the caller.

The model object returned is not yet initialized and has not read its runtime parameters yet.

declare_parameters()

template<int dim>

void aspect::BoundaryHeatFlux::declare_parameters

(

ParameterHandler &

prm

)

Declare the runtime parameters of the registered boundary heat flux models.