ASPECT
Classes | Functions
aspect::BoundaryHeatFlux Namespace Reference

Classes

class  Function
 
class  Interface
 

Functions

template<int dim>
void register_boundary_heat_flux (const std::string &name, const std::string &description, void(*declare_parameters_function)(ParameterHandler &), Interface< dim > *(*factory_function)())
 
template<int dim>
Interface< dim > * create_boundary_heat_flux (ParameterHandler &prm)
 
template<int dim>
void declare_parameters (ParameterHandler &prm)
 
template<int dim>
void write_plugin_graph (std::ostream &output_stream)
 

Detailed Description

A namespace for the definition of things that have to do with describing the boundary heat flux values.

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,
Interface< dim > *(*)()  factory_function 
)

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

Parameters
nameA string that identifies the fluid pressure boundary model
descriptionA text description of what this model does and that will be listed in the documentation of the parameter file.
declare_parameters_functionA 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_functionA pointer to a function that can create an object of this boundary heat flux model.

§ create_boundary_heat_flux()

template<int dim>
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.

§ write_plugin_graph()

template<int dim>
void aspect::BoundaryHeatFlux::write_plugin_graph ( std::ostream &  output_stream)

For the current plugin subsystem, write a connection graph of all of the plugins we know about, in the format that the programs dot and neato understand. This allows for a visualization of how all of the plugins that ASPECT knows about are interconnected, and connect to other parts of the ASPECT code.

Parameters
output_streamThe stream to write the output to.