Merge branch 'orthography_checks' into 'development'

minor orthography adjustments

See merge request damask/DAMASK!718

src/YAML_parse.f90

@@ -472,7 +472,7 @@ end subroutine list_item_inline
 
 !--------------------------------------------------------------------------------------------------
 ! @brief reads a line of YAML block which is already in flow style
-! @details Dicts should be enlcosed within '{}' for it to be consistent with DAMASK YAML parser
+! @details A dict should be enclosed within '{}' for it to be consistent with the DAMASK YAML parser
 !--------------------------------------------------------------------------------------------------
 recursive subroutine line_isFlow(flow,s_flow,line)
 
@@ -590,7 +590,7 @@ end subroutine line_toFlow
 ! @details enters the function when encountered with the list indicator '- '
 ! reads each scalar list item and separates each other with a ','
 ! If list item is non scalar, it stores the offset for that list item block
-! Increase in the indentation level or when list item is not scalar -> 'decide' function is called.
+! Call the 'decide' function if there is an increase in the indentation level or the list item is not a scalar
 ! decrease in indentation level indicates the end of an indentation block
 !-------------------------------------------------------------------------------------------------
 recursive subroutine lst(blck,flow,s_blck,s_flow,offset)

src/grid/DAMASK_grid.f90

@@ -133,7 +133,7 @@ program DAMASK_grid
 
 
 !-------------------------------------------------------------------------------------------------
-! reading field paramters from numerics file and do sanity checks
+! read (and check) field parameters from numerics file
   num_grid => config_numerics%get_dict('grid', defaultVal=emptyDict)
   stagItMax  = num_grid%get_asInt('maxStaggeredIter',defaultVal=10)
   maxCutBack = num_grid%get_asInt('maxCutBack',defaultVal=3)
@@ -376,7 +376,7 @@ program DAMASK_grid
           stepFraction = stepFraction + 1                                                           ! count step
 
 !--------------------------------------------------------------------------------------------------
-! report begin of new step
+! report beginning of new step
           print'(/,1x,a)', '###########################################################################'
           print'(1x,a,1x,es12.5,6(a,i0))', &
                   'Time', t, &
@@ -430,7 +430,7 @@ program DAMASK_grid
           end do
 
 !--------------------------------------------------------------------------------------------------
-! check solution for either advance or retry
+! check solution and either advance or retry with smaller timestep
 
           if ( (all(solres(:)%converged .and. solres(:)%stagConverged)) &                           ! converged
                .and. .not. solres(1)%termIll) then                                                  ! and acceptable solution found

src/phase_mechanical_plastic.f90

@@ -226,7 +226,7 @@ module subroutine plastic_init
 end subroutine plastic_init
 
 !--------------------------------------------------------------------------------------------------
-!> @brief  contains the constitutive equation for calculating the velocity gradient
+!> @brief constitutive equation for calculating the velocity gradient
 ! ToDo: Discuss whether it makes sense if crystallite handles the configuration conversion, i.e.
 ! Mp in, dLp_dMp out
 !--------------------------------------------------------------------------------------------------
@@ -366,7 +366,7 @@ end subroutine plastic_dependentState
 
 
 !--------------------------------------------------------------------------------------------------
-!> @brief for constitutive models having an instantaneous change of state
+!> @brief for constitutive models that have an instantaneous change of state
 !> will return false if delta state is not needed/supported by the constitutive model
 !--------------------------------------------------------------------------------------------------
 module function plastic_deltaState(ph, en) result(broken)

src/phase_mechanical_plastic_dislotungsten.f90

@@ -446,8 +446,8 @@ end subroutine plastic_dislotungsten_result
 !> @brief Calculate shear rates on slip systems, their derivatives with respect to resolved
 !         stress, and the resolved stress.
 !> @details Derivatives and resolved stress are calculated only optionally.
-! NOTE: Against the common convention, the result (i.e. intent(out)) variables are the last to
+! NOTE: Contrary to common convention, here the result (i.e. intent(out)) variables have to be put
-! have the optional arguments at the end
+! at the end since some of them are optional.
 !--------------------------------------------------------------------------------------------------
 pure subroutine kinetics(Mp,T,ph,en, &
                  dot_gamma_pos,dot_gamma_neg,ddot_gamma_dtau_pos,ddot_gamma_dtau_neg,tau_pos_out,tau_neg_out)

src/phase_mechanical_plastic_dislotwin.f90

@@ -64,9 +64,9 @@ submodule(phase:plastic) dislotwin
       P_tw, &
       P_tr
     integer :: &
-      sum_N_sl, &                                                                                   !< total number of active slip system
+      sum_N_sl, &                                                                                   !< total number of active slip systems
-      sum_N_tw, &                                                                                   !< total number of active twin system
+      sum_N_tw, &                                                                                   !< total number of active twin systems
-      sum_N_tr                                                                                      !< total number of active transformation system
+      sum_N_tr                                                                                      !< total number of active transformation systems
     integer,                   allocatable, dimension(:)   :: &
       N_tw, &
       N_tr
@@ -822,8 +822,8 @@ end subroutine plastic_dislotwin_result
 !> @brief Calculate shear rates on slip systems, their derivatives with respect to resolved
 !         stress, and the resolved stress.
 !> @details Derivatives and resolved stress are calculated only optionally.
-! NOTE: Against the common convention, the result (i.e. intent(out)) variables are the last to
+! NOTE: Contrary to common convention, here the result (i.e. intent(out)) variables have to be put
-! have the optional arguments at the end
+! at the end since some of them are optional.
 !--------------------------------------------------------------------------------------------------
 pure subroutine kinetics_sl(Mp,T,ph,en, &
                             dot_gamma_sl,ddot_gamma_dtau_sl,tau_sl)
@@ -898,8 +898,8 @@ end subroutine kinetics_sl
 !> @brief Calculate shear rates on twin systems and their derivatives with respect to resolved
 !         stress.
 !> @details Derivatives are calculated only optionally.
-! NOTE: Against the common convention, the result (i.e. intent(out)) variables are the last to
+! NOTE: Contrary to common convention, here the result (i.e. intent(out)) variables have to be put
-! have the optional arguments at the end.
+! at the end since some of them are optional.
 !--------------------------------------------------------------------------------------------------
 pure subroutine kinetics_tw(Mp,T,abs_dot_gamma_sl,ph,en,&
                             dot_gamma_tw,ddot_gamma_dtau_tw)
@@ -974,8 +974,8 @@ end subroutine kinetics_tw
 !> @brief Calculate shear rates on transformation systems and their derivatives with respect to
 !         resolved stress.
 !> @details Derivatives are calculated only optionally.
-! NOTE: Against the common convention, the result (i.e. intent(out)) variables are the last to
+! NOTE: Contrary to common convention, here the result (i.e. intent(out)) variables have to be put
-! have the optional arguments at the end.
+! at the end since some of them are optional.
 !--------------------------------------------------------------------------------------------------
 pure subroutine kinetics_tr(Mp,T,abs_dot_gamma_sl,ph,en,&
                             dot_gamma_tr,ddot_gamma_dtau_tr)

src/phase_mechanical_plastic_kinehardening.f90

@@ -407,8 +407,8 @@ end subroutine plastic_kinehardening_result
 !> @brief Calculate shear rates on slip systems and their derivatives with respect to resolved
 !         stress.
 !> @details: Derivatives are calculated only optionally.
-! NOTE: Against the common convention, the result (i.e. intent(out)) variables are the last to
+! NOTE: Contrary to common convention, here the result (i.e. intent(out)) variables have to be put
-! have the optional arguments at the end.
+! at the end since some of them are optional.
 !--------------------------------------------------------------------------------------------------
 pure subroutine kinetics(Mp,ph,en, &
                          dot_gamma_pos,dot_gamma_neg,ddot_gamma_dtau_pos,ddot_gamma_dtau_neg)

src/phase_mechanical_plastic_phenopowerlaw.f90

@@ -279,7 +279,7 @@ end function plastic_phenopowerlaw_init
 
 !--------------------------------------------------------------------------------------------------
 !> @brief Calculate plastic velocity gradient and its tangent.
-!> @details asummes that deformation by dislocation glide affects twinned and untwinned volume
+!> @details assumes that deformation by dislocation glide affects twinned and untwinned volume
 !  equally (Taylor assumption). Twinning happens only in untwinned volume
 !--------------------------------------------------------------------------------------------------
 pure module subroutine phenopowerlaw_LpAndItsTangent(Lp,dLp_dMp,Mp,ph,en)
@@ -422,8 +422,8 @@ end subroutine plastic_phenopowerlaw_result
 !> @brief Calculate shear rates on slip systems and their derivatives with respect to resolved
 !         stress.
 !> @details Derivatives are calculated only optionally.
-! NOTE: Against the common convention, the result (i.e. intent(out)) variables are the last to
+! NOTE: Contrary to common convention, here the result (i.e. intent(out)) variables have to be put
-! have the optional arguments at the end.
+! at the end since some of them are optional.
 !--------------------------------------------------------------------------------------------------
 pure subroutine kinetics_sl(Mp,ph,en, &
                             dot_gamma_sl_pos,dot_gamma_sl_neg,ddot_gamma_dtau_sl_pos,ddot_gamma_dtau_sl_neg)
@@ -490,10 +490,10 @@ end subroutine kinetics_sl
 
 !--------------------------------------------------------------------------------------------------
 !> @brief Calculate shear rates on twin systems and their derivatives with respect to resolved
-!         stress. Twinning is assumed to take place only in untwinned volume.
+!         stress. Twinning is assumed to take place only in an untwinned volume.
-!> @details Derivatives are calculated only optionally.
+!> @details Derivatives are calculated and returned if corresponding output variables are present in the argument list.
-! NOTE: Against the common convention, the result (i.e. intent(out)) variables are the last to
+! NOTE: Contrary to common convention, here the result (i.e. intent(out)) variables have to be put
-! have the optional arguments at the end.
+! at the end since some of them are optional.
 !--------------------------------------------------------------------------------------------------
 pure subroutine kinetics_tw(Mp,ph,en,&
                             dot_gamma_tw,ddot_gamma_dtau_tw)

src/result.f90

@@ -234,7 +234,7 @@ end subroutine result_addAttribute_str
 
 
 !--------------------------------------------------------------------------------------------------
-!> @brief Add an integer attribute an object in the result file.
+!> @brief Add an integer attribute to an object in the result file.
 !--------------------------------------------------------------------------------------------------
 subroutine result_addAttribute_int(attrLabel,attrValue,path)
 
@@ -253,7 +253,7 @@ end subroutine result_addAttribute_int
 
 
 !--------------------------------------------------------------------------------------------------
-!> @brief Add a real attribute an object in the result file.
+!> @brief Add a real (float) attribute to an object in the result file.
 !--------------------------------------------------------------------------------------------------
 subroutine result_addAttribute_real(attrLabel,attrValue,path)
 
@@ -272,7 +272,7 @@ end subroutine result_addAttribute_real
 
 
 !--------------------------------------------------------------------------------------------------
-!> @brief Add a string array attribute an object in the result file.
+!> @brief Add a string array attribute to an object in the result file.
 !--------------------------------------------------------------------------------------------------
 subroutine result_addAttribute_str_array(attrLabel,attrValue,path)
 
@@ -291,7 +291,7 @@ end subroutine result_addAttribute_str_array
 
 
 !--------------------------------------------------------------------------------------------------
-!> @brief Add an integer array attribute an object in the result file.
+!> @brief Add an integer array attribute to an object in the result file.
 !--------------------------------------------------------------------------------------------------
 subroutine result_addAttribute_int_array(attrLabel,attrValue,path)
 
@@ -310,7 +310,7 @@ end subroutine result_addAttribute_int_array
 
 
 !--------------------------------------------------------------------------------------------------
-!> @brief Add a real array attribute an object in the result file.
+!> @brief Add a real (float) array attribute to an object in the result file.
 !--------------------------------------------------------------------------------------------------
 subroutine result_addAttribute_real_array(attrLabel,attrValue,path)
 

src/signal.f90

@@ -37,7 +37,7 @@ end subroutine signal_init
 
 !--------------------------------------------------------------------------------------------------
 !> @brief Set global variable signal_SIGINT to .true.
-!> @details This function can be registered to catch signals send to the executable.
+!> @details This function can be registered to catch signals sent to the executable.
 !--------------------------------------------------------------------------------------------------
 subroutine catchSIGINT(sig) bind(C)
 
@@ -52,7 +52,7 @@ end subroutine catchSIGINT
 
 !--------------------------------------------------------------------------------------------------
 !> @brief Set global variable signal_SIGUSR1 to .true.
-!> @details This function can be registered to catch signals send to the executable.
+!> @details This function can be registered to catch signals sent to the executable.
 !--------------------------------------------------------------------------------------------------
 subroutine catchSIGUSR1(sig) bind(C)
 
@@ -67,7 +67,7 @@ end subroutine catchSIGUSR1
 
 !--------------------------------------------------------------------------------------------------
 !> @brief Set global variable signal_SIGUSR2 to .true.
-!> @details This function can be registered to catch signals send to the executable.
+!> @details This function can be registered to catch signals sent to the executable.
 !--------------------------------------------------------------------------------------------------
 subroutine catchSIGUSR2(sig) bind(C)