Skip to content

Commit

Permalink
Don't break hyphenated words in the documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
bangerth committed Dec 31, 2023
1 parent 62db5bb commit ebc4f13
Show file tree
Hide file tree
Showing 9 changed files with 33 additions and 32 deletions.
11 changes: 6 additions & 5 deletions include/aspect/adiabatic_conditions/interface.h
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,12 @@ namespace aspect
using namespace dealii;

/**
* Base class for classes that describe adiabatic conditions, i.e. that
* starts at the top of the domain and integrate pressure and temperature
* as we go down into depth. There are several ways to do this (time-
* dependent or constant, using laterally averaged values or a reference
* profile), therefore we allow for user written plugins.
* Base class for classes that describe adiabatic conditions,
* i.e. that starts at the top of the domain and integrate
* pressure and temperature as we go down into depth. There are
* several ways to do this (time-dependent or constant, using
* laterally averaged values or a reference profile), therefore we
* allow for user written plugins.
*
* @ingroup AdiabaticConditions
*/
Expand Down
4 changes: 2 additions & 2 deletions include/aspect/boundary_composition/initial_composition.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ namespace aspect
/**
* 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.
* outer surfaces (i.e. at the core-mantle and the
* mantle-lithosphere/atmosphere boundaries) are constant.
*
* @ingroup BoundaryCompositions
*/
Expand Down
4 changes: 2 additions & 2 deletions include/aspect/boundary_composition/spherical_constant.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ namespace aspect
/**
* 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.
* outer surfaces (i.e. at the core-mantle and the
* mantle-lithosphere/atmosphere boundaries) are constant.
* This class works for the sphere, spherical shell,
* chunk and ellipsoidal chunk geometries.
*
Expand Down
4 changes: 2 additions & 2 deletions include/aspect/boundary_temperature/spherical_constant.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ namespace aspect
/**
* 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.
* outer surfaces (i.e. at the core-mantle and the
* mantle-lithosphere/atmosphere boundaries) are constant.
*
* @ingroup BoundaryTemperatures
*/
Expand Down
4 changes: 2 additions & 2 deletions include/aspect/initial_temperature/harmonic_perturbation.h
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ namespace aspect
/**
* The radial/depth wave number of the harmonic perturbation. All wave
* number variables are in fact twice the wave number in a
* mathematical sense. This allows the user to prescribe a single up-
* / downswing or half periods.
* mathematical sense. This allows the user to prescribe a single
* up-/downswing or half periods.
*/
int vertical_wave_number;

Expand Down
6 changes: 3 additions & 3 deletions include/aspect/mesh_deformation/interface.h
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ namespace aspect
* A base class for mesh deformation plugins. Each derived class should
* implement a function that determines the deformation velocity for certain
* mesh vertices and store them in a AffineConstraints<double> object. The velocities
* for all non-constrained vertices will be computed by solving a Laplace-
* for all non-constrained vertices will be computed by solving a Laplace
* problem with the given constraints.
*/
template<int dim>
Expand Down Expand Up @@ -215,8 +215,8 @@ namespace aspect
* The main execution step for the mesh deformation implementation. This
* computes the motion of the surface, moves the boundary nodes
* accordingly, redistributes the internal nodes in order to
* preserve mesh regularity, and calculates the Arbitrary-
* Lagrangian-Eulerian correction terms for advected quantities.
* preserve mesh regularity, and calculates the
* Arbitrary-Lagrangian-Eulerian correction terms for advected quantities.
*/
void execute();

Expand Down
4 changes: 2 additions & 2 deletions include/aspect/particle/integrator/rk_4.h
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ namespace aspect

/**
* Perform an integration step of moving the particles of one cell
* by the specified timestep dt. This class implements a Runge-
* Kutta integration scheme that is fourth order accurate
* by the specified timestep dt. This class implements a Runge-Kutta
* integration scheme that is fourth order accurate
* in space.
*
* @param [in] begin_particle An iterator to the first particle to be moved.
Expand Down
4 changes: 2 additions & 2 deletions include/aspect/plugins.h
Original file line number Diff line number Diff line change
Expand Up @@ -264,8 +264,8 @@ namespace aspect
* Given the name of one plugin, create a corresponding object and
* return a pointer to it. The second argument provides a hint where
* this function was called from, to be printed in case there is an
* error. Before returning, let the newly created object read its run-
* time parameters from the parameter object.
* error. Before returning, let the newly created object read its
* run-time parameters from the parameter object.
*
* Ownership of the object is handed over to the caller of this
* function.
Expand Down
24 changes: 12 additions & 12 deletions include/aspect/postprocess/visualization.h
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,10 @@ namespace aspect
* the solution.
*
* Using this way of describing a visualization postprocessor will yield
* a class that would then have the following base classes: -
* aspect::Postprocess::VisualizationPostprocessors::Interface -
* aspect::SimulatorAccess - dealii::DataPostprocessor or any of the
* other ones listed above
* a class that would then have the following base classes:
* - aspect::Postprocess::VisualizationPostprocessors::Interface
* - aspect::SimulatorAccess
* - dealii::DataPostprocessor or any of the other ones listed above
*
* <li> The second possibility is for a class to not derive from
* dealii::DataPostprocessor but instead from the CellDataVectorCreator
Expand Down Expand Up @@ -568,25 +568,25 @@ namespace aspect
bool write_higher_order_output;

/**
* For mesh deformation computations ASPECT uses an Arbitrary-Lagrangian-
* Eulerian formulation to handle deforming the domain, so the mesh
* has its own velocity field. This may be written as an output field
* by setting output_mesh_velocity to true.
* For mesh deformation computations ASPECT uses an
* Arbitrary-Lagrangian-Eulerian formulation to handle deforming the
* domain, so the mesh has its own velocity field. This may be
* written as an output field by setting output_mesh_velocity to true.
*/
bool output_mesh_velocity;

/**
* For mesh deformation computations ASPECT uses an Arbitrary-Lagrangian-
* Eulerian formulation to handle deforming the domain, so the mesh
* For mesh deformation computations ASPECT uses an
* Arbitrary-Lagrangian-Eulerian formulation to handle deforming the domain, so the mesh
* has a field that determines the displacement from the reference
* configuration. This may be written as an output field by setting
* this flag to true.
*/
bool output_mesh_displacement;

/**
* For mesh deformation computations ASPECT uses an Arbitrary-Lagrangian-
* Eulerian formulation to handle deforming the domain, and we output the
* For mesh deformation computations ASPECT uses an
* Arbitrary-Lagrangian-Eulerian formulation to handle deforming the domain, and we output the
* mesh in its deformed state by default. If this flag is set to true,
* the mesh is written undeformed.
*/
Expand Down

0 comments on commit ebc4f13

Please sign in to comment.