Skip to content

Commit c9d1e8e

Browse files
committed
Renaming mixed rk to MixedRK in the codebase
1 parent 8b10b39 commit c9d1e8e

10 files changed

Lines changed: 15 additions & 15 deletions

File tree

.github/workflows/CI_parallel.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1172,7 +1172,7 @@ jobs:
11721172
if: ('!cancelled()')
11731173

11741174
#
1175-
# 8) Mixed RK
1175+
# 8) MixedRK
11761176
# ----------------------------
11771177
- name: Build MultiphaseMixedRK
11781178
working-directory: ./Solver/test/Multiphase/MixedRK/SETUP

.github/workflows/CI_sequential 3.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,7 @@ jobs:
337337
if: ('!cancelled()')
338338

339339
#
340-
# 10) Mixed RK
340+
# 10) MixedRK
341341
# ----------------------------
342342
- name: Build MultiphaseMixedRK
343343
working-directory: ./Solver/test/Multiphase/MixedRK/SETUP

Solver/src/libs/discretization/DGSEMClass.f90

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -268,8 +268,8 @@ SUBROUTINE ConstructDGSem( self, meshFileName_, controlVariables, &
268268
! -------------------------
269269
call constructMeshFromFile( self % mesh, self % mesh % meshFileName, CurrentNodes, Nx, Ny, Nz, MeshInnerCurves , dir2D, useRelaxPeriodic, success )
270270

271-
! initialize the solution if the time stepping scheme is mixed RK, since Q is needed in the METIS partitioning
272-
if(trim(controlVariables % stringValueForKey('explicit method', requestedLength = LINE_LENGTH)) == 'mixed rk') then
271+
! initialize the solution if the time stepping scheme is MixedRK, since Q is needed in the METIS partitioning
272+
if(trim(controlVariables % stringValueForKey('explicit method', requestedLength = LINE_LENGTH)) == 'MixedRK') then
273273
call self % mesh % CheckIfMeshIs2D(.true.)
274274
call self % mesh % ConstructGeometry()
275275
call self % mesh % AllocateStorage(self % NDOF, controlVariables,computeGradients)

Solver/src/libs/mesh/HexMesh.f90

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1886,7 +1886,7 @@ END SUBROUTINE WriteCoordFile
18861886
!
18871887
subroutine HexMesh_CheckIfMeshIs2D(self, ignore_mpi_section)
18881888
implicit none
1889-
logical, optional , intent(in) :: ignore_mpi_section !added bool to ignore the mpi section in this code. First used in relation to mixed RK stepping
1889+
logical, optional , intent(in) :: ignore_mpi_section !added bool to ignore the mpi section in this code. First used in relation to MixedRK stepping
18901890

18911891
!-arguments---------------------------------------
18921892
class(HexMesh), intent(inout) :: self

Solver/src/libs/mesh/METISPartitioning.f90

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ subroutine GetMETISElementsPartition(mesh, no_of_domains, elementsDomain, nodesD
22
!
33
! *********************************************************************
44
! This subroutine performs the mesh partitioning using METIS
5-
! and then manual load balancing for mixed RK used in multiphase
5+
! and then manual load balancing for MixedRK used in multiphase
66
! *********************************************************************
77
!
88
use HexMeshClass
@@ -57,7 +57,7 @@ subroutine GetMETISElementsPartition(mesh, no_of_domains, elementsDomain, nodesD
5757

5858
! Check if we should do water/air counting based on explicit method
5959
do_water_air_count = .false.
60-
if(trim(controlVariables % stringValueForKey('explicit method', requestedLength = LINE_LENGTH)) == 'mixed rk') then
60+
if(trim(controlVariables % stringValueForKey('explicit method', requestedLength = LINE_LENGTH)) == 'MixedRK') then
6161
do_water_air_count = .true.
6262
end if
6363

Solver/src/libs/timeintegrator/ExplicitMethods.f90

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ MODULE ExplicitMethods
4141
character(len=*), parameter :: SSPRK43_NAME = "ssprk43"
4242
character(len=*), parameter :: EULER_RK3_NAME = "euler rk3"
4343
character(len=*), parameter :: LSERK14_4_NAME = "lserk14-4"
44-
character(len=*), parameter :: MIXED_RK_NAME = "mixed rk"
44+
character(len=*), parameter :: MIXED_RK_NAME = "mixedrk"
4545
character(len=*), parameter :: ML_RK3_NAME = "multi level rk3"
4646

4747

@@ -212,10 +212,10 @@ SUBROUTINE TakeMixedRKStep( mesh, particles, t, deltaT, ComputeTimeDerivative ,
212212
!
213213
! *****************************************************************************************
214214
! Uses RK3 in phase1 and LSERK14-4 in phase2, think phase1 is air and phase2 is water. Of course, this will only yield an advantage if:
215-
! - you can get away with a time step using the mixed RK that is 5x times larger than that in pure RK3 scheme,
215+
! - you can get away with a time step using the MixedRK that is 5x times larger than that in pure RK3 scheme,
216216
! - AND if there are at LEAST 20+% air elements (aim for 50% or more)
217217
! A stand-alone LSERK14-4 implimetnation is given in TakeLSERK14_4Step
218-
! The mixed RK scheme is valid only for the multiphase solver and throws an error otherwise,
218+
! The MixedRK scheme is valid only for the multiphase solver and throws an error otherwise,
219219
! However, the rest of this function still has its implementation consistent
220220
! with the other RK steppers in case anyone needed to extend it
221221
! *****************************************************************************************
@@ -247,7 +247,7 @@ SUBROUTINE TakeMixedRKStep( mesh, particles, t, deltaT, ComputeTimeDerivative ,
247247

248248

249249
#if !defined(MULTIPHASE)
250-
error stop 'Mixed RK time stepping is only implemented for the multiphase solver'
250+
error stop 'MixedRK time stepping is only implemented for the multiphase solver'
251251
#else
252252

253253
! Arrays to store the original solution for all elements

Solver/src/libs/timeintegrator/TimeIntegrator.f90

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ SUBROUTINE constructTimeIntegrator(self,controlVariables, sem, initial_iter, ini
365365
case (EULER_RK3_KEY)
366366
write(STD_OUT,'(A)') "Euler-RK3"
367367
case (MIXED_RK_KEY)
368-
write(STD_OUT,'(A)') "Mixed rk"
368+
write(STD_OUT,'(A)') "MixedRK"
369369
case (ML_RK3_KEY)
370370
write(STD_OUT,'(A)') "Multi-Level RK3"
371371
write(STD_OUT,'(35X,A,A23,I14)') "->" , "Number of Level: ", self % ML_nLevel

Solver/test/Multiphase/MixedRK/mixedRK.control

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ interface width (m) = 0.01
5555
interface tension (N/m) = 1e-16 !72.8e-3
5656

5757
Time integration = Explicit
58-
explicit method = mixed rk
58+
explicit method = MixedRK
5959

6060
partitioning = METIS
6161

doc/UserManual.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1064,7 +1064,7 @@ \chapter{Explicit Solvers}
10641064

10651065
\textbf{simulation type} & \textit{CHARACTER}: Specifies if HORSES3D must perform a ’steady-state’ or a ’time-accurate’. If 'time-accurate' the solver switches to BDF integration and uses FAS as a pseudo problem solver. Compatible only with 'FAS'. & 'steady-state' \\ \hline
10661066

1067-
explicit method & \textit{CHARACTER}: Select desired Runge-Kutta solver. Options are: 'Euler', 'RK3', 'RK5', 'RKOpt', 'SSPRK33', 'SSPRK43', 'EULER RK3', and Mixed RK. The option 'EULER RK3' is a hybrid temporal scheme thought to be used with RL p-Adaptation and BR1 as viscous discretization. & RK3 \\ \hline
1067+
explicit method & \textit{CHARACTER}: Select desired Runge-Kutta solver. Options are: 'Euler', 'RK3', 'RK5', 'RKOpt', 'SSPRK33', 'SSPRK43', 'EULER RK3', and MixedRK. The option 'EULER RK3' is a hybrid temporal scheme thought to be used with RL p-Adaptation and BR1 as viscous discretization. & RK3 \\ \hline
10681068

10691069
rk order & \textit{INTEGER}: Order of Runge-Kutta method optimized for steady-state solver ('RKOpt'). Possible orders are from 2 to 7. & 2 \\ \hline
10701070

doc/pages/user_manual/explicit-solvers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The main keywords to use it are shown in the table below
99
|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
1010
| time integration | *CHARACTER*: This is the main keyword to activate the multigrid solvers. The value of it should be set to 'FAS' for the Full Approximation Scheme (FAS) nonlinear multigrid solvers and to 'AnisFAS' for anisotropic FAS schemes. | 'explicit' |
1111
| simulation type | *CHARACTER*: Specifies if HORSES3D must perform a ’steady-state’ or a ’time-accurate’. If 'time-accurate' the solver switches to BDF integration and uses FAS as a pseudo problem solver. Compatible only with 'FAS'. | 'steady-state' |
12-
| explicit method | *CHARACTER*: Select desired Runge-Kutta solver. Options are: 'Euler', 'RK3', 'RK5', 'RKOpt', 'SSPRK33', 'SSPRK43, and 'Mixed RK' | RK3 |
12+
| explicit method | *CHARACTER*: Select desired Runge-Kutta solver. Options are: 'Euler', 'RK3', 'RK5', 'RKOpt', 'SSPRK33', 'SSPRK43, and 'MixedRK' | RK3 |
1313
| rk order | *INTEGER*: Order of Runge-Kutta method optimized for steady-state solver ('RKOpt'). Possible orders are from 2 to 7. | 2 |
1414
| limit timestep | *LOGICAL*: Activate the positivity limiter of Zhang and Shu (only for SSPRK methods). | .false. |
1515
| limiter minimum | *REAL*: Minimum value of density and pressure allowed by the limiter. | 1e-13 |

0 commit comments

Comments
 (0)