Skip to content

Commit

Permalink
Addressing whitespace
Browse files Browse the repository at this point in the history
  • Loading branch information
csdechant committed Dec 20, 2024
1 parent 4b5a202 commit fb79626
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 8 deletions.
10 changes: 6 additions & 4 deletions include/actions/AddDriftDiffusionAction.h
Original file line number Diff line number Diff line change
Expand Up @@ -61,15 +61,16 @@ class AddDriftDiffusionAction : public Action
/**
* Helper function that supplies the Aux kernels to convert scaled position units
* when the user sets position_units to non-unity value
* @param position_name The name of the position variable in the format of {component + "_position" + block}
* @param position_name The name of the position variable in the format of {component +
* "_position" + block}
* @param component The spatial component defined as x=0, y=1, and z=2
*/
virtual void addPosition(const std::string & position_name, const int & component);

/**
/**
* Helper function that supplies the Aux kernels to convert densities from logarithmic form
* @param particle_name The name of the density variable
*/
*/
virtual void addDensityLog(const std::string & particle_name);

/**
Expand All @@ -81,7 +82,8 @@ class AddDriftDiffusionAction : public Action

/**
* Helper function that supplies the Aux kernels for the electric field
* @param Efield_name The name of the electric field variable in the format of {"Efield" + component + block}
* @param Efield_name The name of the electric field variable in the format of {"Efield" +
* component + block}
* @param potential_name The name of the electrostatic potential
* @param component The spatial component defined as x=0, y=1, and z=2
*/
Expand Down
5 changes: 3 additions & 2 deletions include/actions/AddPeriodicControllers.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,10 @@ class AddPeriodicControllers : public Action
virtual void act();

protected:
/**
/**
* Function that adds a 'TimePeriod' controller
* @param enableORdisable Stating to uses either the "enable_objects" or "disable_objects" parameter from 'TimePeriod'
* @param enableORdisable Stating to uses either the "enable_objects" or "disable_objects"
* parameter from 'TimePeriod'
* @param objects The name of objects that are either being enabled or disabled
* @param start_times The time values to start the controller
* @param end_times The time values to stop the controller
Expand Down
6 changes: 4 additions & 2 deletions include/actions/AddPeriodicRelativeNodalDifference.h
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ class AddPeriodicRelativeNodalDifference : public Action
/**
* Function for setting AuxKernels for the previous and sudo previous solutions
* @param variable_name The name of the auxvariable to stores the previous cycle solution
* @param var_old_name The name of the variable storing the solution at the beginning of the time step
* @param var_old_name The name of the variable storing the solution at the beginning of the time
* step
*/
virtual void addPerviousSolutionsKernels(const std::string & variable_name,
const std::string & var_old_name);
Expand Down Expand Up @@ -68,7 +69,8 @@ class AddPeriodicRelativeNodalDifference : public Action
const std::string & var_old_name,
const std::string & name);
/**
* Function that adds a 'TimePeriod' controller to begin calculating the relative periodic difference
* Function that adds a 'TimePeriod' controller to begin calculating the relative periodic
* difference
* @param objects The name of objects that are either being enabled or disabled
* @param start_times The time values to start the controller
* @param end_times The time values to stop the controller
Expand Down

0 comments on commit fb79626

Please sign in to comment.