[cig-commits] commit 2505 by heister to /var/svn/dealii/aspect
dealii.demon at gmail.com
dealii.demon at gmail.com
Sun Apr 13 07:49:27 PDT 2014
Revision 2505
doxygen comment layout and rewrapping
U trunk/aspect/include/aspect/adiabatic_conditions.h
U trunk/aspect/include/aspect/boundary_composition/box.h
U trunk/aspect/include/aspect/boundary_composition/initial_composition.h
U trunk/aspect/include/aspect/boundary_composition/interface.h
U trunk/aspect/include/aspect/boundary_composition/spherical_constant.h
U trunk/aspect/include/aspect/boundary_temperature/box.h
U trunk/aspect/include/aspect/boundary_temperature/constant.h
U trunk/aspect/include/aspect/boundary_temperature/initial_temperature.h
U trunk/aspect/include/aspect/boundary_temperature/interface.h
U trunk/aspect/include/aspect/boundary_temperature/spherical_constant.h
U trunk/aspect/include/aspect/boundary_temperature/tan_gurnis.h
U trunk/aspect/include/aspect/compositional_initial_conditions/function.h
U trunk/aspect/include/aspect/compositional_initial_conditions/interface.h
U trunk/aspect/include/aspect/geometry_model/box.h
U trunk/aspect/include/aspect/geometry_model/interface.h
U trunk/aspect/include/aspect/geometry_model/sphere.h
U trunk/aspect/include/aspect/geometry_model/spherical_shell.h
U trunk/aspect/include/aspect/global.h
U trunk/aspect/include/aspect/gravity_model/interface.h
U trunk/aspect/include/aspect/gravity_model/radial.h
U trunk/aspect/include/aspect/gravity_model/vertical.h
U trunk/aspect/include/aspect/initial_conditions/adiabatic.h
U trunk/aspect/include/aspect/initial_conditions/box.h
U trunk/aspect/include/aspect/initial_conditions/function.h
U trunk/aspect/include/aspect/initial_conditions/harmonic_perturbation.h
U trunk/aspect/include/aspect/initial_conditions/interface.h
U trunk/aspect/include/aspect/initial_conditions/spherical_shell.h
U trunk/aspect/include/aspect/introspection.h
U trunk/aspect/include/aspect/material_model/duretz_et_al.h
U trunk/aspect/include/aspect/material_model/interface.h
U trunk/aspect/include/aspect/material_model/latent_heat.h
U trunk/aspect/include/aspect/material_model/simple.h
U trunk/aspect/include/aspect/material_model/steinberger.h
U trunk/aspect/include/aspect/material_model/table.h
U trunk/aspect/include/aspect/material_model/tan_gurnis.h
U trunk/aspect/include/aspect/mesh_refinement/composition.h
U trunk/aspect/include/aspect/mesh_refinement/density.h
U trunk/aspect/include/aspect/mesh_refinement/interface.h
U trunk/aspect/include/aspect/mesh_refinement/nonadiabatic_temperature.h
U trunk/aspect/include/aspect/mesh_refinement/temperature.h
U trunk/aspect/include/aspect/mesh_refinement/thermal_energy_density.h
U trunk/aspect/include/aspect/mesh_refinement/topography.h
U trunk/aspect/include/aspect/mesh_refinement/velocity.h
U trunk/aspect/include/aspect/mesh_refinement/viscosity.h
U trunk/aspect/include/aspect/particle/generator.h
U trunk/aspect/include/aspect/particle/integrator.h
U trunk/aspect/include/aspect/particle/output.h
U trunk/aspect/include/aspect/particle/particle.h
U trunk/aspect/include/aspect/particle/world.h
U trunk/aspect/include/aspect/plugins.h
U trunk/aspect/include/aspect/postprocess/composition_statistics.h
U trunk/aspect/include/aspect/postprocess/depth_average.h
U trunk/aspect/include/aspect/postprocess/duretz_et_al.h
U trunk/aspect/include/aspect/postprocess/dynamic_topography.h
U trunk/aspect/include/aspect/postprocess/heat_flux_statistics.h
U trunk/aspect/include/aspect/postprocess/interface.h
U trunk/aspect/include/aspect/postprocess/table_heat_flux_statistics.h
U trunk/aspect/include/aspect/postprocess/table_velocity_statistics.h
U trunk/aspect/include/aspect/postprocess/tan_gurnis.h
U trunk/aspect/include/aspect/postprocess/temperature_statistics.h
U trunk/aspect/include/aspect/postprocess/tracer.h
U trunk/aspect/include/aspect/postprocess/velocity_statistics.h
U trunk/aspect/include/aspect/postprocess/visualization/artificial_viscosity.h
U trunk/aspect/include/aspect/postprocess/visualization/density.h
U trunk/aspect/include/aspect/postprocess/visualization/dynamic_topography.h
U trunk/aspect/include/aspect/postprocess/visualization/error_indicator.h
U trunk/aspect/include/aspect/postprocess/visualization/friction_heating.h
U trunk/aspect/include/aspect/postprocess/visualization/melt_fraction.h
U trunk/aspect/include/aspect/postprocess/visualization/nonadiabatic_pressure.h
U trunk/aspect/include/aspect/postprocess/visualization/nonadiabatic_temperature.h
U trunk/aspect/include/aspect/postprocess/visualization/partition.h
U trunk/aspect/include/aspect/postprocess/visualization/seismic_anomalies.h
U trunk/aspect/include/aspect/postprocess/visualization/seismic_vp.h
U trunk/aspect/include/aspect/postprocess/visualization/seismic_vs.h
U trunk/aspect/include/aspect/postprocess/visualization/specific_heat.h
U trunk/aspect/include/aspect/postprocess/visualization/strain_rate.h
U trunk/aspect/include/aspect/postprocess/visualization/thermal_expansivity.h
U trunk/aspect/include/aspect/postprocess/visualization/thermodynamic_phase.h
U trunk/aspect/include/aspect/postprocess/visualization/viscosity.h
U trunk/aspect/include/aspect/postprocess/visualization/viscosity_ratio.h
U trunk/aspect/include/aspect/postprocess/visualization.h
U trunk/aspect/include/aspect/simulator.h
U trunk/aspect/include/aspect/simulator_access.h
U trunk/aspect/include/aspect/termination_criteria/end_step.h
U trunk/aspect/include/aspect/termination_criteria/end_time.h
U trunk/aspect/include/aspect/termination_criteria/interface.h
U trunk/aspect/include/aspect/termination_criteria/steady_rms_velocity.h
U trunk/aspect/include/aspect/termination_criteria/user_request.h
U trunk/aspect/include/aspect/velocity_boundary_conditions/function.h
U trunk/aspect/include/aspect/velocity_boundary_conditions/gplates.h
U trunk/aspect/include/aspect/velocity_boundary_conditions/interface.h
http://www.dealii.org/websvn/revision.php?repname=Aspect+Repository&path=%2F&rev=2505&peg=2505
Diff:
Modified: trunk/aspect/include/aspect/adiabatic_conditions.h
===================================================================
--- trunk/aspect/include/aspect/adiabatic_conditions.h 2014-04-13 14:37:05 UTC (rev 2504)
+++ trunk/aspect/include/aspect/adiabatic_conditions.h 2014-04-13 14:49:25 UTC (rev 2505)
@@ -37,13 +37,14 @@
/**
- * A class that represents adiabatic conditions, i.e. that starts at the top of
- * the domain and integrates pressure and temperature as we go down into depth.
+ * A class that represents adiabatic conditions, i.e. that starts at the top
+ * of the domain and integrates pressure and temperature as we go down into
+ * depth.
*
- * @note The implementation has numerous deficiencies indicated in the .cc file
- * and may not quite compute what we want. Specifically, it doesn't currently
- * take into account all the physical parameters it needs, and it also doesn't
- * get gravity right with the exception of the simplest cases.
+ * @note The implementation has numerous deficiencies indicated in the .cc
+ * file and may not quite compute what we want. Specifically, it doesn't
+ * currently take into account all the physical parameters it needs, and it
+ * also doesn't get gravity right with the exception of the simplest cases.
*/
template <int dim>
class AdiabaticConditions
@@ -51,8 +52,8 @@
public:
/**
* Constructor. Compute the adiabatic conditions along a vertical
- * transect of the geometry based on the given material model
- * and other quantities.
+ * transect of the geometry based on the given material model and other
+ * quantities.
*/
AdiabaticConditions (const GeometryModel::Interface<dim> &geometry_model,
const GravityModel::Interface<dim> &gravity_model,
@@ -68,12 +69,12 @@
double temperature (const Point<dim> &p) const;
/**
- * Return the adiabatic temperature profile as a vector of values corresponding
- * to increasing depth.
+ * Return the adiabatic temperature profile as a vector of values
+ * corresponding to increasing depth.
*
- * @param values The output vector of depth averaged values.
- * The function takes the pre-existing size of this vector
- * as the number of depth slices.
+ * @param values The output vector of depth averaged values. The
+ * function takes the pre-existing size of this vector as the number of
+ * depth slices.
*/
void get_adiabatic_temperature_profile(std::vector<double> &values) const;
@@ -90,8 +91,8 @@
/**
* Vectors of values of temperatures and pressures on a transect into
- * depth at which we have computed them. The public member functions
- * of this class interpolate linearly between these points.
+ * depth at which we have computed them. The public member functions of
+ * this class interpolate linearly between these points.
*/
std::vector<double> temperatures, pressures;
@@ -103,9 +104,8 @@
/**
* A reference to the geometry model which we need when converting
- * between arbitrary points at which temperature and pressure
- * are interpolated and the depth coordinate we use to pre-compute
- * values.
+ * between arbitrary points at which temperature and pressure are
+ * interpolated and the depth coordinate we use to pre-compute values.
*/
const GeometryModel::Interface<dim> &geometry_model;
};
Modified: trunk/aspect/include/aspect/boundary_composition/box.h
===================================================================
--- trunk/aspect/include/aspect/boundary_composition/box.h 2014-04-13 14:37:05 UTC (rev 2504)
+++ trunk/aspect/include/aspect/boundary_composition/box.h 2014-04-13 14:49:25 UTC (rev 2505)
@@ -43,18 +43,19 @@
{
public:
/**
- * Return the composition that is to hold at a particular location on the
- * boundary of the domain. This function returns constant compositions
- * at the left and right boundaries.
+ * Return the composition that is to hold at a particular location on
+ * the boundary of the domain. This function returns constant
+ * compositions at the left and right boundaries.
*
- * @param geometry_model The geometry model that describes the domain. This may
- * be used to determine whether the boundary composition model is implemented
- * for this geometry.
- * @param boundary_indicator The boundary indicator of the part of the boundary
- * of the domain on which the point is located at which we are requesting the
- * composition.
- * @param location The location of the point at which we ask for the composition.
- **/
+ * @param geometry_model The geometry model that describes the domain.
+ * This may be used to determine whether the boundary composition
+ * model is implemented for this geometry.
+ * @param boundary_indicator The boundary indicator of the part of the
+ * boundary of the domain on which the point is located at which we
+ * are requesting the composition.
+ * @param location The location of the point at which we ask for the
+ * composition.
+ */
virtual
double composition (const GeometryModel::Interface<dim> &geometry_model,
const unsigned int boundary_indicator,
@@ -62,16 +63,15 @@
const unsigned int compositional_field) const;
/**
- * Declare the parameters this class takes through input files.
- * This class declares the inner and outer boundary compositions.
+ * Declare the parameters this class takes through input files. This
+ * class declares the inner and outer boundary compositions.
*/
static
void
declare_parameters (ParameterHandler &prm);
/**
- * Read the parameters this class declares from the parameter
- * file.
+ * Read the parameters this class declares from the parameter file.
*/
virtual
void
@@ -79,19 +79,19 @@
/**
* Initialize this class for a given simulator. This function
- * overloads that of the SimulatorAccess base class. It calls
- * the respective function of the base class and then performs
- * some basic sanity checks on the parameter values previously
- * read from the input file.
+ * overloads that of the SimulatorAccess base class. It calls the
+ * respective function of the base class and then performs some basic
+ * sanity checks on the parameter values previously read from the
+ * input file.
*
* @param simulator A reference to the main simulator object.
- **/
+ */
virtual void initialize (const Simulator<dim> &simulator);
private:
/**
- * The values of the various composition variables on each of the 2*dim
- * boundaries of the box.
+ * The values of the various composition variables on each of the
+ * 2*dim boundaries of the box.
*/
std::vector<double> composition_values[2*dim];
};
Modified: trunk/aspect/include/aspect/boundary_composition/initial_composition.h
===================================================================
--- trunk/aspect/include/aspect/boundary_composition/initial_composition.h 2014-04-13 14:37:05 UTC (rev 2504)
+++ trunk/aspect/include/aspect/boundary_composition/initial_composition.h 2014-04-13 14:49:25 UTC (rev 2505)
@@ -32,10 +32,10 @@
namespace BoundaryComposition
{
/**
- * A class that implements a composition boundary condition for a spherical
- * shell geometry in which the composition at the inner and outer surfaces
- * (i.e. at the core-mantle and the mantle-lithosphere/atmosphere boundaries)
- * are constant.
+ * A class that implements a composition boundary condition for a
+ * spherical shell geometry in which the composition at the inner and
+ * outer surfaces (i.e. at the core-mantle and the mantle-
+ * lithosphere/atmosphere boundaries) are constant.
*
* @ingroup BoundaryCompositions
*/
@@ -44,18 +44,20 @@
{
public:
/**
- * Return the composition that is to hold at a particular location on the
- * boundary of the domain. This function returns the constant compositions
- * read from the parameter file for the inner and outer boundaries.
+ * Return the composition that is to hold at a particular location on
+ * the boundary of the domain. This function returns the constant
+ * compositions read from the parameter file for the inner and outer
+ * boundaries.
*
- * @param geometry_model The geometry model that describes the domain. This may
- * be used to determine whether the boundary composition model is implemented
- * for this geometry.
- * @param boundary_indicator The boundary indicator of the part of the boundary
- * of the domain on which the point is located at which we are requesting the
- * composition.
- * @param location The location of the point at which we ask for the composition.
- **/
+ * @param geometry_model The geometry model that describes the domain.
+ * This may be used to determine whether the boundary composition
+ * model is implemented for this geometry.
+ * @param boundary_indicator The boundary indicator of the part of the
+ * boundary of the domain on which the point is located at which we
+ * are requesting the composition.
+ * @param location The location of the point at which we ask for the
+ * composition.
+ */
virtual
double composition (const GeometryModel::Interface<dim> &geometry_model,
const unsigned int boundary_indicator,
@@ -63,8 +65,8 @@
const unsigned int compositional_field) const;
/**
- * Return the minimal composition on that part of the boundary
- * on which Dirichlet conditions are posed.
+ * Return the minimal composition on that part of the boundary on
+ * which Dirichlet conditions are posed.
*
* This value is used in computing dimensionless numbers such as the
* Nusselt number indicating heat flux.
@@ -73,8 +75,8 @@
double minimal_composition (const std::set<types::boundary_id> &fixed_boundary_ids) const;
/**
- * Return the maximal composition on that part of the boundary
- * on which Dirichlet conditions are posed.
+ * Return the maximal composition on that part of the boundary on
+ * which Dirichlet conditions are posed.
*
* This value is used in computing dimensionless numbers such as the
* Nusselt number indicating heat flux.
@@ -83,16 +85,15 @@
double maximal_composition (const std::set<types::boundary_id> &fixed_boundary_ids) const;
/**
- * Declare the parameters this class takes through input files.
- * This class declares the inner and outer boundary compositions.
+ * Declare the parameters this class takes through input files. This
+ * class declares the inner and outer boundary compositions.
*/
static
void
declare_parameters (ParameterHandler &prm);
/**
- * Read the parameters this class declares from the parameter
- * file.
+ * Read the parameters this class declares from the parameter file.
*/
virtual
void
Modified: trunk/aspect/include/aspect/boundary_composition/interface.h
===================================================================
--- trunk/aspect/include/aspect/boundary_composition/interface.h 2014-04-13 14:37:05 UTC (rev 2504)
+++ trunk/aspect/include/aspect/boundary_composition/interface.h 2014-04-13 14:49:25 UTC (rev 2505)
@@ -58,19 +58,20 @@
virtual ~Interface();
/**
- * Return the composition that is to hold at a particular location on the
- * boundary of the domain.
+ * Return the composition that is to hold at a particular location on
+ * the boundary of the domain.
*
- * @param geometry_model The geometry model that describes the domain. This may
- * be used to determine whether the boundary composition model is implemented
- * for this geometry.
- * @param boundary_indicator The boundary indicator of the part of the boundary
- * of the domain on which the point is located at which we are requesting the
- * composition.
- * @param location The location of the point at which we ask for the composition.
- * @param compositional_field The number of the compositional field for which we
+ * @param geometry_model The geometry model that describes the domain.
+ * This may be used to determine whether the boundary composition
+ * model is implemented for this geometry.
+ * @param boundary_indicator The boundary indicator of the part of the
+ * boundary of the domain on which the point is located at which we
* are requesting the composition.
- **/
+ * @param location The location of the point at which we ask for the
+ * composition.
+ * @param compositional_field The number of the compositional field
+ * for which we are requesting the composition.
+ */
virtual
double composition (const GeometryModel::Interface<dim> &geometry_model,
const unsigned int boundary_indicator,
@@ -78,20 +79,20 @@
const unsigned int compositional_field) const = 0;
/**
- * Declare the parameters this class takes through input files.
- * The default implementation of this function does not describe
- * any parameters. Consequently, derived classes do not have to
- * overload this function if they do not take any runtime parameters.
+ * Declare the parameters this class takes through input files. The
+ * default implementation of this function does not describe any
+ * parameters. Consequently, derived classes do not have to overload
+ * this function if they do not take any runtime parameters.
*/
static
void
declare_parameters (ParameterHandler &prm);
/**
- * Read the parameters this class declares from the parameter
- * file. The default implementation of this function does not read
- * any parameters. Consequently, derived classes do not have to
- * overload this function if they do not take any runtime parameters.
+ * Read the parameters this class declares from the parameter file.
+ * The default implementation of this function does not read any
+ * parameters. Consequently, derived classes do not have to overload
+ * this function if they do not take any runtime parameters.
*/
virtual
void
@@ -100,16 +101,17 @@
/**
- * Register a boundary composition model so that it can be selected from the parameter file.
+ * Register a boundary composition model so that it can be selected from
+ * the parameter file.
*
* @param name A string that identifies the boundary composition model
- * @param description A text description of what this model
- * does and that will be listed in the documentation of
- * the parameter file.
- * @param declare_parameters_function A pointer to a function that can be used to
- * declare the parameters that this geometry model wants to read from input files.
- * @param factory_function A pointer to a function that can create an object of
- * this boundary composition model.
+ * @param description A text description of what this model does and that
+ * will be listed in the documentation of the parameter file.
+ * @param declare_parameters_function A pointer to a function that can be
+ * used to declare the parameters that this geometry model wants to read
+ * from input files.
+ * @param factory_function A pointer to a function that can create an
+ * object of this boundary composition model.
*
* @ingroup BoundaryCompositions
*/
@@ -121,8 +123,9 @@
Interface<dim> *(*factory_function) ());
/**
- * 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.
+ * 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.
*
* @ingroup BoundaryCompositions
*/
@@ -132,7 +135,8 @@
/**
- * Declare the runtime parameters of the registered boundary composition models.
+ * Declare the runtime parameters of the registered boundary composition
+ * models.
*
* @ingroup BoundaryCompositions
*/
@@ -142,8 +146,9 @@
/**
- * Given a class name, a name, and a description for the parameter file for a boundary composition model, register it with
- * the functions that can declare their parameters and create these objects.
+ * Given a class name, a name, and a description for the parameter file
+ * for a boundary composition model, register it with the functions that
+ * can declare their parameters and create these objects.
*
* @ingroup BoundaryCompositions
*/
Modified: trunk/aspect/include/aspect/boundary_composition/spherical_constant.h
===================================================================
--- trunk/aspect/include/aspect/boundary_composition/spherical_constant.h 2014-04-13 14:37:05 UTC (rev 2504)
+++ trunk/aspect/include/aspect/boundary_composition/spherical_constant.h 2014-04-13 14:49:25 UTC (rev 2505)
@@ -31,10 +31,10 @@
namespace BoundaryComposition
{
/**
- * A class that implements a composition boundary condition for a spherical
- * shell geometry in which the composition at the inner and outer surfaces
- * (i.e. at the core-mantle and the mantle-lithosphere/atmosphere boundaries)
- * are constant.
+ * A class that implements a composition boundary condition for a
+ * spherical shell geometry in which the composition at the inner and
+ * outer surfaces (i.e. at the core-mantle and the mantle-
+ * lithosphere/atmosphere boundaries) are constant.
*
* @ingroup BoundaryCompositions
*/
@@ -43,18 +43,20 @@
{
public:
/**
- * Return the composition that is to hold at a particular location on the
- * boundary of the domain. This function returns the constant compositions
- * read from the parameter file for the inner and outer boundaries.
+ * Return the composition that is to hold at a particular location on
+ * the boundary of the domain. This function returns the constant
+ * compositions read from the parameter file for the inner and outer
+ * boundaries.
*
- * @param geometry_model The geometry model that describes the domain. This may
- * be used to determine whether the boundary composition model is implemented
- * for this geometry.
- * @param boundary_indicator The boundary indicator of the part of the boundary
- * of the domain on which the point is located at which we are requesting the
- * composition.
- * @param location The location of the point at which we ask for the composition.
- **/
+ * @param geometry_model The geometry model that describes the domain.
+ * This may be used to determine whether the boundary composition
+ * model is implemented for this geometry.
+ * @param boundary_indicator The boundary indicator of the part of the
+ * boundary of the domain on which the point is located at which we
+ * are requesting the composition.
+ * @param location The location of the point at which we ask for the
+ * composition.
+ */
virtual
double composition (const GeometryModel::Interface<dim> &geometry_model,
const unsigned int boundary_indicator,
@@ -62,8 +64,8 @@
const unsigned int compositional_field) const;
/**
- * Return the minimal composition on that part of the boundary
- * on which Dirichlet conditions are posed.
+ * Return the minimal composition on that part of the boundary on
+ * which Dirichlet conditions are posed.
*
* This value is used in computing dimensionless numbers such as the
* Nusselt number indicating heat flux.
@@ -72,8 +74,8 @@
double minimal_composition (const std::set<types::boundary_id> &fixed_boundary_ids) const;
/**
- * Return the maximal composition on that part of the boundary
- * on which Dirichlet conditions are posed.
+ * Return the maximal composition on that part of the boundary on
+ * which Dirichlet conditions are posed.
*
* This value is used in computing dimensionless numbers such as the
* Nusselt number indicating heat flux.
@@ -82,16 +84,15 @@
double maximal_composition (const std::set<types::boundary_id> &fixed_boundary_ids) const;
/**
- * Declare the parameters this class takes through input files.
- * This class declares the inner and outer boundary compositions.
+ * Declare the parameters this class takes through input files. This
+ * class declares the inner and outer boundary compositions.
*/
static
void
declare_parameters (ParameterHandler &prm);
/**
- * Read the parameters this class declares from the parameter
- * file.
+ * Read the parameters this class declares from the parameter file.
*/
virtual
void
Modified: trunk/aspect/include/aspect/boundary_temperature/box.h
===================================================================
--- trunk/aspect/include/aspect/boundary_temperature/box.h 2014-04-13 14:37:05 UTC (rev 2504)
+++ trunk/aspect/include/aspect/boundary_temperature/box.h 2014-04-13 14:49:25 UTC (rev 2505)
@@ -41,26 +41,27 @@
{
public:
/**
- * Return the temperature that is to hold at a particular location on the
- * boundary of the domain. This function returns constant temperatures
- * at the left and right boundaries.
+ * Return the temperature that is to hold at a particular location on
+ * the boundary of the domain. This function returns constant
+ * temperatures at the left and right boundaries.
*
- * @param geometry_model The geometry model that describes the domain. This may
- * be used to determine whether the boundary temperature model is implemented
- * for this geometry.
- * @param boundary_indicator The boundary indicator of the part of the boundary
- * of the domain on which the point is located at which we are requesting the
- * temperature.
- * @param location The location of the point at which we ask for the temperature.
- **/
+ * @param geometry_model The geometry model that describes the domain.
+ * This may be used to determine whether the boundary temperature
+ * model is implemented for this geometry.
+ * @param boundary_indicator The boundary indicator of the part of the
+ * boundary of the domain on which the point is located at which we
+ * are requesting the temperature.
+ * @param location The location of the point at which we ask for the
+ * temperature.
+ */
virtual
double temperature (const GeometryModel::Interface<dim> &geometry_model,
const unsigned int boundary_indicator,
const Point<dim> &location) const;
/**
- * Return the minimal the temperature on that part of the boundary
- * on which Dirichlet conditions are posed.
+ * Return the minimal the temperature on that part of the boundary on
+ * which Dirichlet conditions are posed.
*
* This value is used in computing dimensionless numbers such as the
* Nusselt number indicating heat flux.
@@ -69,8 +70,8 @@
double minimal_temperature (const std::set<types::boundary_id> &fixed_boundary_ids) const;
/**
- * Return the maximal the temperature on that part of the boundary
- * on which Dirichlet conditions are posed.
+ * Return the maximal the temperature on that part of the boundary on
+ * which Dirichlet conditions are posed.
*
* This value is used in computing dimensionless numbers such as the
* Nusselt number indicating heat flux.
@@ -79,16 +80,15 @@
double maximal_temperature (const std::set<types::boundary_id> &fixed_boundary_ids) const;
/**
- * Declare the parameters this class takes through input files.
- * This class declares the inner and outer boundary temperatures.
+ * Declare the parameters this class takes through input files. This
+ * class declares the inner and outer boundary temperatures.
*/
static
void
declare_parameters (ParameterHandler &prm);
/**
- * Read the parameters this class declares from the parameter
- * file.
+ * Read the parameters this class declares from the parameter file.
*/
virtual
void
Modified: trunk/aspect/include/aspect/boundary_temperature/constant.h
===================================================================
--- trunk/aspect/include/aspect/boundary_temperature/constant.h 2014-04-13 14:37:05 UTC (rev 2504)
+++ trunk/aspect/include/aspect/boundary_temperature/constant.h 2014-04-13 14:49:25 UTC (rev 2505)
@@ -31,10 +31,10 @@
namespace BoundaryTemperature
{
/**
- * A class that implements a temperature boundary condition for an arbitrary
- * geometry, where it returns a constant value for a given boundary indicator.
- * Takes an ordered list of temperatures, where the position in the list
- * corresponds to the indicator for that temperature.
+ * A class that implements a temperature boundary condition for an
+ * arbitrary geometry, where it returns a constant value for a given
+ * boundary indicator. Takes an ordered list of temperatures, where the
+ * position in the list corresponds to the indicator for that temperature.
*
* @ingroup BoundaryTemperatures
*/
@@ -43,26 +43,27 @@
{
public:
/**
- * Return the temperature that is to hold at a particular location on the
- * boundary of the domain. This function returns the constant temperatures
- * read from the parameter file.
+ * Return the temperature that is to hold at a particular location on
+ * the boundary of the domain. This function returns the constant
+ * temperatures read from the parameter file.
*
- * @param geometry_model The geometry model that describes the domain. This may
- * be used to determine whether the boundary temperature model is implemented
- * for this geometry.
- * @param boundary_indicator The boundary indicator of the part of the boundary
- * of the domain on which the point is located at which we are requesting the
- * temperature.
- * @param location The location of the point at which we ask for the temperature.
- **/
+ * @param geometry_model The geometry model that describes the domain.
+ * This may be used to determine whether the boundary temperature
+ * model is implemented for this geometry.
+ * @param boundary_indicator The boundary indicator of the part of the
+ * boundary of the domain on which the point is located at which we
+ * are requesting the temperature.
+ * @param location The location of the point at which we ask for the
+ * temperature.
+ */
virtual
double temperature (const GeometryModel::Interface<dim> &geometry_model,
const unsigned int boundary_indicator,
const Point<dim> &location) const;
/**
- * Return the minimal the temperature on that part of the boundary
- * on which Dirichlet conditions are posed.
+ * Return the minimal the temperature on that part of the boundary on
+ * which Dirichlet conditions are posed.
*
* This value is used in computing dimensionless numbers such as the
* Nusselt number indicating heat flux.
@@ -71,8 +72,8 @@
double minimal_temperature (const std::set<types::boundary_id> &fixed_boundary_ids) const;
/**
- * Return the maximal the temperature on that part of the boundary
- * on which Dirichlet conditions are posed.
+ * Return the maximal the temperature on that part of the boundary on
+ * which Dirichlet conditions are posed.
*
* This value is used in computing dimensionless numbers such as the
* Nusselt number indicating heat flux.
@@ -81,16 +82,15 @@
double maximal_temperature (const std::set<types::boundary_id> &fixed_boundary_ids) const;
/**
- * Declare the parameters this class takes through input files.
- * This class declares the inner and outer boundary temperatures.
+ * Declare the parameters this class takes through input files. This
+ * class declares the inner and outer boundary temperatures.
*/
static
void
declare_parameters (ParameterHandler &prm);
/**
- * Read the parameters this class declares from the parameter
- * file.
+ * Read the parameters this class declares from the parameter file.
*/
virtual
void
Modified: trunk/aspect/include/aspect/boundary_temperature/initial_temperature.h
===================================================================
--- trunk/aspect/include/aspect/boundary_temperature/initial_temperature.h 2014-04-13 14:37:05 UTC (rev 2504)
+++ trunk/aspect/include/aspect/boundary_temperature/initial_temperature.h 2014-04-13 14:49:25 UTC (rev 2505)
@@ -31,9 +31,9 @@
namespace BoundaryTemperature
{
/**
- * A class that implements a temperature boundary condition for an arbitrary
- * geometry in which the temperature at the boundaries are the same as in the
- * initial conditions.
+ * A class that implements a temperature boundary condition for an
+ * arbitrary geometry in which the temperature at the boundaries are the
+ * same as in the initial conditions.
*
* @ingroup BoundaryTemperatures
*/
@@ -42,26 +42,28 @@
{
public:
/**
- * Return the temperature that is to hold at a particular location on the
- * boundary of the domain. This function returns the constant temperatures
- * read from the parameter file for the inner and outer boundaries.
+ * Return the temperature that is to hold at a particular location on
+ * the boundary of the domain. This function returns the constant
+ * temperatures read from the parameter file for the inner and outer
+ * boundaries.
*
- * @param geometry_model The geometry model that describes the domain. This may
- * be used to determine whether the boundary temperature model is implemented
- * for this geometry.
- * @param boundary_indicator The boundary indicator of the part of the boundary
- * of the domain on which the point is located at which we are requesting the
- * temperature.
- * @param location The location of the point at which we ask for the temperature.
- **/
+ * @param geometry_model The geometry model that describes the domain.
+ * This may be used to determine whether the boundary temperature
+ * model is implemented for this geometry.
+ * @param boundary_indicator The boundary indicator of the part of the
+ * boundary of the domain on which the point is located at which we
+ * are requesting the temperature.
+ * @param location The location of the point at which we ask for the
+ * temperature.
+ */
virtual
double temperature (const GeometryModel::Interface<dim> &geometry_model,
const unsigned int boundary_indicator,
const Point<dim> &location) const;
/**
- * Return the minimal the temperature on that part of the boundary
- * on which Dirichlet conditions are posed.
+ * Return the minimal the temperature on that part of the boundary on
+ * which Dirichlet conditions are posed.
*
* This value is used in computing dimensionless numbers such as the
* Nusselt number indicating heat flux.
@@ -70,8 +72,8 @@
double minimal_temperature (const std::set<types::boundary_id> &fixed_boundary_ids) const;
/**
- * Return the maximal the temperature on that part of the boundary
- * on which Dirichlet conditions are posed.
+ * Return the maximal the temperature on that part of the boundary on
+ * which Dirichlet conditions are posed.
*
* This value is used in computing dimensionless numbers such as the
* Nusselt number indicating heat flux.
@@ -80,16 +82,15 @@
double maximal_temperature (const std::set<types::boundary_id> &fixed_boundary_ids) const;
/**
- * Declare the parameters this class takes through input files.
- * This class declares the inner and outer boundary temperatures.
+ * Declare the parameters this class takes through input files. This
+ * class declares the inner and outer boundary temperatures.
*/
static
void
declare_parameters (ParameterHandler &prm);
/**
- * Read the parameters this class declares from the parameter
- * file.
+ * Read the parameters this class declares from the parameter file.
*/
virtual
void
Modified: trunk/aspect/include/aspect/boundary_temperature/interface.h
===================================================================
--- trunk/aspect/include/aspect/boundary_temperature/interface.h 2014-04-13 14:37:05 UTC (rev 2504)
+++ trunk/aspect/include/aspect/boundary_temperature/interface.h 2014-04-13 14:49:25 UTC (rev 2505)
@@ -58,25 +58,26 @@
virtual ~Interface();
/**
- * Return the temperature that is to hold at a particular location on the
- * boundary of the domain.
+ * Return the temperature that is to hold at a particular location on
+ * the boundary of the domain.
*
- * @param geometry_model The geometry model that describes the domain. This may
- * be used to determine whether the boundary temperature model is implemented
- * for this geometry.
- * @param boundary_indicator The boundary indicator of the part of the boundary
- * of the domain on which the point is located at which we are requesting the
- * temperature.
- * @param location The location of the point at which we ask for the temperature.
- **/
+ * @param geometry_model The geometry model that describes the domain.
+ * This may be used to determine whether the boundary temperature
+ * model is implemented for this geometry.
+ * @param boundary_indicator The boundary indicator of the part of the
+ * boundary of the domain on which the point is located at which we
+ * are requesting the temperature.
+ * @param location The location of the point at which we ask for the
+ * temperature.
+ */
virtual
double temperature (const GeometryModel::Interface<dim> &geometry_model,
const unsigned int boundary_indicator,
const Point<dim> &location) const = 0;
/**
- * Return the minimal the temperature on that part of the boundary
- * on which Dirichlet conditions are posed.
+ * Return the minimal the temperature on that part of the boundary on
+ * which Dirichlet conditions are posed.
*
* This value is used in computing dimensionless numbers such as the
* Nusselt number indicating heat flux.
@@ -86,8 +87,8 @@
std::set<types::boundary_id>()) const = 0;
/**
- * Return the maximal the temperature on that part of the boundary
- * on which Dirichlet conditions are posed.
+ * Return the maximal the temperature on that part of the boundary on
+ * which Dirichlet conditions are posed.
*
* This value is used in computing dimensionless numbers such as the
* Nusselt number indicating heat flux.
@@ -97,20 +98,20 @@
std::set<types::boundary_id>()) const = 0;
/**
- * Declare the parameters this class takes through input files.
- * The default implementation of this function does not describe
- * any parameters. Consequently, derived classes do not have to
- * overload this function if they do not take any runtime parameters.
+ * Declare the parameters this class takes through input files. The
+ * default implementation of this function does not describe any
+ * parameters. Consequently, derived classes do not have to overload
+ * this function if they do not take any runtime parameters.
*/
static
void
declare_parameters (ParameterHandler &prm);
/**
- * Read the parameters this class declares from the parameter
- * file. The default implementation of this function does not read
- * any parameters. Consequently, derived classes do not have to
- * overload this function if they do not take any runtime parameters.
+ * Read the parameters this class declares from the parameter file.
+ * The default implementation of this function does not read any
+ * parameters. Consequently, derived classes do not have to overload
+ * this function if they do not take any runtime parameters.
*/
virtual
void
@@ -119,16 +120,17 @@
/**
- * Register a boundary temperature model so that it can be selected from the parameter file.
+ * Register a boundary temperature model so that it can be selected from
+ * the parameter file.
*
* @param name A string that identifies the boundary temperature model
- * @param description A text description of what this model
- * does and that will be listed in the documentation of
- * the parameter file.
- * @param declare_parameters_function A pointer to a function that can be used to
- * declare the parameters that this geometry model wants to read from input files.
- * @param factory_function A pointer to a function that can create an object of
- * this boundary temperature model.
+ * @param description A text description of what this model does and that
+ * will be listed in the documentation of the parameter file.
+ * @param declare_parameters_function A pointer to a function that can be
+ * used to declare the parameters that this geometry model wants to read
+ * from input files.
+ * @param factory_function A pointer to a function that can create an
+ * object of this boundary temperature model.
*
* @ingroup BoundaryTemperatures
*/
@@ -140,8 +142,9 @@
Interface<dim> *(*factory_function) ());
/**
- * 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.
+ * 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.
*
* @ingroup BoundaryTemperatures
*/
@@ -151,7 +154,8 @@
/**
- * Declare the runtime parameters of the registered boundary temperature models.
+ * Declare the runtime parameters of the registered boundary temperature
+ * models.
*
* @ingroup BoundaryTemperatures
*/
@@ -161,8 +165,9 @@
/**
- * Given a class name, a name, and a description for the parameter file for a boundary temperature model, register it with
- * the functions that can declare their parameters and create these objects.
+ * Given a class name, a name, and a description for the parameter file
+ * for a boundary temperature model, register it with the functions that
+ * can declare their parameters and create these objects.
*
* @ingroup BoundaryTemperatures
*/
Modified: trunk/aspect/include/aspect/boundary_temperature/spherical_constant.h
===================================================================
--- trunk/aspect/include/aspect/boundary_temperature/spherical_constant.h 2014-04-13 14:37:05 UTC (rev 2504)
+++ trunk/aspect/include/aspect/boundary_temperature/spherical_constant.h 2014-04-13 14:49:25 UTC (rev 2505)
@@ -31,10 +31,10 @@
namespace BoundaryTemperature
{
/**
- * A class that implements a temperature boundary condition for a spherical
- * shell geometry in which the temperature at the inner and outer surfaces
- * (i.e. at the core-mantle and the mantle-lithosphere/atmosphere boundaries)
- * are constant.
+ * A class that implements a temperature boundary condition for a
+ * spherical shell geometry in which the temperature at the inner and
+ * outer surfaces (i.e. at the core-mantle and the mantle-
+ * lithosphere/atmosphere boundaries) are constant.
*
* @ingroup BoundaryTemperatures
*/
@@ -43,26 +43,28 @@
{
public:
/**
- * Return the temperature that is to hold at a particular location on the
- * boundary of the domain. This function returns the constant temperatures
- * read from the parameter file for the inner and outer boundaries.
+ * Return the temperature that is to hold at a particular location on
+ * the boundary of the domain. This function returns the constant
+ * temperatures read from the parameter file for the inner and outer
+ * boundaries.
*
- * @param geometry_model The geometry model that describes the domain. This may
- * be used to determine whether the boundary temperature model is implemented
- * for this geometry.
- * @param boundary_indicator The boundary indicator of the part of the boundary
- * of the domain on which the point is located at which we are requesting the
- * temperature.
- * @param location The location of the point at which we ask for the temperature.
- **/
+ * @param geometry_model The geometry model that describes the domain.
+ * This may be used to determine whether the boundary temperature
+ * model is implemented for this geometry.
+ * @param boundary_indicator The boundary indicator of the part of the
+ * boundary of the domain on which the point is located at which we
+ * are requesting the temperature.
+ * @param location The location of the point at which we ask for the
+ * temperature.
+ */
virtual
double temperature (const GeometryModel::Interface<dim> &geometry_model,
const unsigned int boundary_indicator,
const Point<dim> &location) const;
/**
- * Return the minimal the temperature on that part of the boundary
- * on which Dirichlet conditions are posed.
+ * Return the minimal the temperature on that part of the boundary on
+ * which Dirichlet conditions are posed.
*
* This value is used in computing dimensionless numbers such as the
* Nusselt number indicating heat flux.
@@ -71,8 +73,8 @@
double minimal_temperature (const std::set<types::boundary_id> &fixed_boundary_ids) const;
/**
- * Return the maximal the temperature on that part of the boundary
- * on which Dirichlet conditions are posed.
+ * Return the maximal the temperature on that part of the boundary on
+ * which Dirichlet conditions are posed.
*
* This value is used in computing dimensionless numbers such as the
* Nusselt number indicating heat flux.
@@ -81,16 +83,15 @@
double maximal_temperature (const std::set<types::boundary_id> &fixed_boundary_ids) const;
/**
- * Declare the parameters this class takes through input files.
- * This class declares the inner and outer boundary temperatures.
+ * Declare the parameters this class takes through input files. This
+ * class declares the inner and outer boundary temperatures.
*/
static
void
declare_parameters (ParameterHandler &prm);
/**
- * Read the parameters this class declares from the parameter
- * file.
+ * Read the parameters this class declares from the parameter file.
*/
virtual
void
Modified: trunk/aspect/include/aspect/boundary_temperature/tan_gurnis.h
===================================================================
--- trunk/aspect/include/aspect/boundary_temperature/tan_gurnis.h 2014-04-13 14:37:05 UTC (rev 2504)
+++ trunk/aspect/include/aspect/boundary_temperature/tan_gurnis.h 2014-04-13 14:49:25 UTC (rev 2505)
@@ -31,8 +31,8 @@
namespace BoundaryTemperature
{
/**
- * A class that implements a temperature boundary condition for the tan/gurnis benchmark
- * in a box geometry.
+ * A class that implements a temperature boundary condition for the
+ * tan/gurnis benchmark in a box geometry.
*
* @ingroup BoundaryTemperatures
*/
@@ -41,26 +41,27 @@
{
public:
/**
- * Return the temperature that is to hold at a particular location on the
- * boundary of the domain. This function returns constant temperatures
- * at the left and right boundaries.
+ * Return the temperature that is to hold at a particular location on
+ * the boundary of the domain. This function returns constant
+ * temperatures at the left and right boundaries.
*
- * @param geometry_model The geometry model that describes the domain. This may
- * be used to determine whether the boundary temperature model is implemented
More information about the CIG-COMMITS
mailing list