Skip to content

Commit c600fad

Browse files
committed
FDS Source: Doxygen fixes only
1 parent 8b8d744 commit c600fad

File tree

4 files changed

+22
-21
lines changed

4 files changed

+22
-21
lines changed

Source/devc.f90

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -32,45 +32,45 @@ MODULE DEVICE_VARIABLES
3232
!> \brief Derived type storing location and value informaton for DEVICE\%SUBDEVICE
3333

3434
TYPE SUBDEVICE_TYPE
35-
!> !\{
35+
!> @{
3636
!> Intermediate value used for computing device SPATIAL_STATISTIC or TEMPORAL_STATISTIC
3737
REAL(EB) :: VALUE_1=0._EB,VALUE_2=0._EB,VALUE_3=0._EB,VALUE_4=0._EB
38-
!> !\}
39-
!> !\{
38+
!> @}
39+
!> @{
4040
!> Subdevice point, line, or bounding box physical coordinate (m)
4141
REAL(EB) :: X1,X2,Y1,Y2,Z1,Z2
42-
!> !\}
42+
!> @}
4343
INTEGER :: MESH !< Subdevice mesh location
44-
!> !\{
44+
!> @{
4545
!> Subdevice point, line, or bounding box grid index
4646
INTEGER :: I1=-1,I2=-1,J1=-1,J2=-1,K1=-1,K2=-1
47-
!> !\}
47+
!> @}
4848
INTEGER :: N_PATH=0 !< Number of grid cells along subdevice path for TRANSMISSION or PATH OBSCURATION
49-
!> !\{
49+
!> @{
5050
!> Grid index for a grid cell along subdevice path for TRANSMISSION or PATH OBSCURATION
5151
INTEGER, ALLOCATABLE, DIMENSION(:) :: I_PATH,J_PATH,K_PATH
52-
! !\}
52+
!> @}
5353
REAL(EB), ALLOCATABLE, DIMENSION(:) :: D_PATH
54-
!<Segment length in a grid cell along subdevice path for TRANSMISSION or PATH OBSCURATION
54+
!< Segment length in a grid cell along subdevice path for TRANSMISSION or PATH OBSCURATION
5555
END TYPE SUBDEVICE_TYPE
5656

5757
!> \brief Derived type for a measurement device (DEVC)
5858

5959
TYPE DEVICE_TYPE
6060
TYPE(SUBDEVICE_TYPE), ALLOCATABLE, DIMENSION(:) :: SUBDEVICE !<Array of subdevices
6161
REAL(EB) :: T !< Used to track time stuff for a DEVC that is part of an ASPIRATION detector.
62-
!> !\{
62+
!> @{
6363
!> Physical coordinate of a point DEVC
6464
REAL(EB) :: X,Y,Z
65-
!> !\}
66-
!> !\{
65+
!> @}
66+
!> @{
6767
!> Origin of a linear array of devices
6868
REAL(EB) :: X0,Y0,Z0
69-
!> !\}
70-
!> !\{
69+
!> @}
70+
!> @{
7171
!> Physical coordinates for DEVC spanning a line, plane, or volume
7272
REAL(EB) :: X1,X2,Y1,Y2,Z1,Z2
73-
!> !\}
73+
!> @}
7474
REAL(EB) :: INITIAL_VALUE=-1.E10_EB,INSTANT_VALUE,VALUE=0._EB,SMOOTHED_VALUE=-1.E10_EB,PREVIOUS_VALUE=0._EB, &
7575
DEPTH,TMP_L,Y_C,OBSCURATION,DELAY,ROTATION,SMOOTHING_FACTOR=0._EB,SMOOTHING_TIME=-1._EB, &
7676
VALUE_1,VALUE_2,VALUE_3,VALUE_4,&
@@ -134,7 +134,7 @@ MODULE CONTROL_VARIABLES
134134

135135
IMPLICIT NONE (TYPE,EXTERNAL)
136136

137-
!> !\{
137+
!> @{
138138
!> Parameter defining the type of control function for CONTROL\%CONTROL_INDEX
139139
! When adding more functions:
140140
! 1-50 are fucntions with a logical output that have only one input
@@ -150,11 +150,11 @@ MODULE CONTROL_VARIABLES
150150
CF_POWER=201,CF_DIVIDE=202,&
151151
CF_SUM=301,CF_SUBTRACT=302,CF_MULTIPLY=303,CF_MIN=304,CF_MAX=305,&
152152
CF_PERCENTILE=401
153-
!> !\}
154-
!> !\{
153+
!> @}
154+
!> @{
155155
!> Parameter used to define the type of input for CONTROL\%INPUT_TYPE
156156
INTEGER, PARAMETER :: DEVICE_INPUT=1,CONTROL_INPUT=2,CONSTANT_INPUT=3
157-
!> !\}
157+
!> @}
158158

159159
INTEGER :: N_CTRL = 0 !< Length of CONTROL
160160
INTEGER :: N_CTRL_FILES = 0 !< Number of CHID_ctrl.csv output files
@@ -183,7 +183,7 @@ MODULE CONTROL_VARIABLES
183183
INTEGER, ALLOCATABLE, DIMENSION (:) :: INPUT_TYPE
184184
!< Array of inidicating if a specific input to a control function is a device and a control functon
185185
REAL(EB) :: SETPOINT(2)=1.E30_EB
186-
!<Setpoint for a control function. For a DEADBAND function contains the lower and upper bounds of the DEADBAND
186+
!< Setpoint for a control function. For a DEADBAND function contains the lower and upper bounds of the DEADBAND
187187
REAL(EB) :: DELAY=0._EB !<Delay time (s) for a TIME_DELAY function
188188
REAL(EB) :: T_CHANGE=1000000._EB !<Time the control function changed state
189189
REAL(EB) :: CONSTANT=-9.E30_EB !<Value assigned to CONSTANT on a CTRL input

Source/dump.f90

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7286,6 +7286,7 @@ END SUBROUTINE UPDATE_DEVICES_2
72867286
!> \param IND2 Index of the sometimes needed second output quantity
72877287
!> \param Y_INDEX Index of the primitive gas species
72887288
!> \param Z_INDEX Index of the gas species mixture
7289+
!> \param ELEM_INDX Index of the chemical element
72897290
!> \param PART_INDEX Index of the Lagrangian particle class
72907291
!> \param VELO_INDEX Index of the velocity component, x=1, y=2, z=3
72917292
!> \param PIPE_INDEX Index of the pipe branch

Source/func.f90

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5839,7 +5839,6 @@ END SUBROUTINE TRANSFORM_COORDINATES
58395839
!> \brief Find the determinant of a matrix A of order N
58405840
!> \param A is a square matrix N x N
58415841
!> \param N is the order of the matrix
5842-
!> \param DET is the result
58435842

58445843
RECURSIVE FUNCTION DETERMINANT(A, N) RESULT(DET)
58455844
INTEGER, INTENT(IN) :: N

Source/init.f90

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3396,6 +3396,7 @@ END SUBROUTINE INIT_THIN_WALL_CELL
33963396
!> \brief Assign internal values of temp, density, and mass fraction
33973397
!> \param NM Mesh number
33983398
!> \param IW WALL index
3399+
!> \param TT Curent time (s)
33993400

34003401
SUBROUTINE SET_DENSITY_AND_MASS_FRACTIONS_AT_WALL(NM,IW,TT)
34013402

0 commit comments

Comments
 (0)