Coupling

CMakeLists.txt

@@ -135,6 +135,7 @@ add_subdirectory(UserInterface)
 
 add_subdirectory(PhysicsPackages)
 add_subdirectory(DataStructures)
+add_subdirectory(Coupling)
 
 ####################################################################################################
 # Compile SCONE static library

CollisionOperator/CollisionProcessors/neutronCEstd_class.f90

@@ -274,7 +274,7 @@ subroutine implicit(self, p, tally, collDat, thisCycle, nextCycle)
 
       do i = 1, n
         call fission % sampleOut(mu, phi, E_out, collDat % E, p % pRNG, lambda)
-
+        
         ! Skip if a delayed particle is produced in prompt-only mode
         if (self % neglectDelayed .and. lambda < huge(lambda)) cycle
 
@@ -420,7 +420,7 @@ subroutine inelastic(self, p, tally, collDat, thisCycle, nextCycle)
     collDat % MT = self % nuc % invertInelastic(collDat % E, p % pRNG)
     reac => uncorrelatedReactionCE_CptrCast(self % xsData % getReaction(collDat % MT, collDat % nucIdx))
     if (.not.associated(reac)) call fatalError(Here, "Failed to get scattering reaction")
-
+    
     ! Scatter particle
     if (reac % inCMFrame()) then
       collDat % A =  self % nuc % getMass()
@@ -429,7 +429,7 @@ subroutine inelastic(self, p, tally, collDat, thisCycle, nextCycle)
       call self % scatterInLAB(p, collDat, reac)
     end if
 
-    ! Apply weigth change using ingoing collision particle energy
+    ! Apply weight change using ingoing collision particle energy
     p % w = p % w * reac % release(collDat % E)
 
   end subroutine inelastic

CollisionOperator/scatteringKernels_func.f90

@@ -1,9 +1,10 @@
 module scatteringKernels_func
 
   use numPrecision
-  use genericProcedures, only : rotateVector
-  use RNG_class,         only : RNG
-  use particle_class,    only : particle
+  use universalVariables, only : MINIMUM_ENERGY
+  use genericProcedures,  only : rotateVector
+  use RNG_class,          only : RNG
+  use particle_class,     only : particle
 
   ! Nuclear Data
   use ceNeutronNuclide_inter, only : ceNeutronNuclide
@@ -53,7 +54,8 @@ subroutine asymptoticScatter(E,mu,A)
     mu = (A*mu + 1)*sqrt(E_in/E)* inv_Ap1
 
     ! Correct possible nuclear data shortcomings
-    if (mu > ONE) mu = ONE
+    mu = min(mu, ONE)
+    E = max(E, MINIMUM_ENERGY)
 
   end subroutine asymptoticScatter
 
@@ -87,7 +89,8 @@ subroutine asymptoticInelasticScatter(E,mu,E_out,A)
     mu = mu * sqrt(E_out/E) + sqrt(E_in/E)* inv_Ap1
 
     ! Correct possible nuclear data shortcomings
-    if (mu > ONE) mu = ONE
+    mu = min(mu, ONE)
+    E = max(E, MINIMUM_ENERGY)
 
   end subroutine asymptoticInelasticScatter
 

Coupling/CMakeLists.txt

@@ -0,0 +1,3 @@
+add_sources( ./couplingAdmin_class.f90)
+
+add_integration_tests( ./Tests/couplingAdmin_iTest.f90)

Coupling/Tests/couplingAdmin_iTest.f90

@@ -0,0 +1,180 @@
+module couplingAdmin_iTest
+
+  use numPrecision
+  use universalVariables
+  use dictionary_class,    only : dictionary
+  use dictParser_func,     only : fileToDict
+  use fieldFactory_func,   only : new_field
+  use couplingAdmin_class, only : couplingAdmin
+  use funit
+
+  implicit none
+
+contains
+
+  !!
+  !! Coupling admin integration test
+  !!
+@Test
+  subroutine test_coupling()
+    type(couplingAdmin)           :: coupler
+    character(pathLen), parameter :: path = './IntegrationTestFiles/Coupling/test_coupling'
+    character(pathLen), parameter :: sendPath = './IntegrationTestFiles/Coupling/toDriver.dat'
+    character(pathLen), parameter :: recvPath = './IntegrationTestFiles/Coupling/toSCONE.dat'
+    character(pathLen), parameter :: tallyPath = './IntegrationTestFiles/Coupling/sconeOut.m'
+    type(dictionary)              :: dict
+    integer(shortInt)             :: it, unit
+    logical(defBool)              :: exists, correctFile
+    character(nameLen)            :: line
+
+    ! Create a recv file to prevent SCONE from hanging
+    open(newunit=unit, file=recvPath, status="replace", action="write")
+    write(unit, '(A)') 'SIGUSR1'
+    close(unit)
+
+    ! Attempt a coupling update before initialisation: no files should be produced
+    ! or deleted
+    it = 5
+    call coupler % couple(it)
+
+    inquire(file=recvPath, exist=exists)
+    @assertTrue(exists)
+    inquire(file=tallyPath, exist=exists)
+    @assertFalse(exists)
+    inquire(file=sendPath, exist=exists)
+    @assertFalse(exists)
+
+    ! Initialise
+    call fileToDict(dict, path)
+    call coupler % init(dict)
+
+    ! Feed in different iteration numbers and see whether files are produced
+    ! This one should not result in any information exchange
+    it = 1
+    call coupler % couple(it)
+
+    inquire(file=recvPath, exist=exists)
+    @assertTrue(exists)
+    inquire(file=tallyPath, exist=exists)
+    @assertFalse(exists)
+    inquire(file=sendPath, exist=exists)
+    @assertFalse(exists)
+
+    ! This one should be coupled
+    it = 5
+    call coupler % couple(it)
+
+    inquire(file=recvPath, exist=exists)
+    @assertFalse(exists)
+    inquire(file=tallyPath, exist=exists)
+    @assertTrue(exists)
+    inquire(file=sendPath, exist=exists)
+    @assertTrue(exists)
+
+    ! Send file should contain SIGUSR1
+    open(newunit=unit, file=sendPath, status='old', action='read')
+    read(unit,'(A)') line
+    close(unit)
+    correctFile = (trim(line) == 'SIGUSR1')
+    @assertTrue(correctFile)
+
+    ! Reset the files
+    open(newunit=unit, file=tallyPath, status='old')
+    close(unit, status='delete')
+    open(newunit=unit, file=sendPath, status='old')
+    close(unit, status='delete')
+
+    ! This one should end coupling due to hitting the maximum iteration
+    ! No recv file is necessary
+    it = 10
+    call coupler % couple(it)
+
+    inquire(file=recvPath, exist=exists)
+    @assertFalse(exists)
+    inquire(file=tallyPath, exist=exists)
+    @assertTrue(exists)
+    inquire(file=sendPath, exist=exists)
+    @assertTrue(exists)
+
+    ! Send file should contain SIGTERM
+    open(newunit=unit, file=sendPath, status='old', action='read')
+    read(unit,'(A)') line
+    close(unit)
+    correctFile = (trim(line) == 'SIGTERM')
+    @assertTrue(correctFile)
+
+    ! Reset the files
+    open(newunit=unit, file=tallyPath, status='old')
+    close(unit, status='delete')
+    open(newunit=unit, file=sendPath, status='old')
+    close(unit, status='delete')
+    open(newunit=unit, file=recvPath, status="replace", action="write")
+    write(unit, '(A)') 'SIGTERM'
+    close(unit)
+
+    ! Coupling should not occur
+    it = 15
+    call coupler % couple(it)
+
+    inquire(file=recvPath, exist=exists)
+    @assertTrue(exists)
+    inquire(file=tallyPath, exist=exists)
+    @assertFalse(exists)
+    inquire(file=sendPath, exist=exists)
+    @assertFalse(exists)
+
+    ! Reinitialise the coupler, ensuring that no coupling occurs successfully
+    ! until reinitialisation
+    call coupler % kill()
+    it = 5
+    call coupler % couple(it)
+
+    inquire(file=recvPath, exist=exists)
+    @assertTrue(exists)
+    inquire(file=tallyPath, exist=exists)
+    @assertFalse(exists)
+    inquire(file=sendPath, exist=exists)
+    @assertFalse(exists)
+
+    call coupler % init(dict)
+
+    ! Given the recv file, coupling should occur on this iteration, but not on the 10th
+    it = 5
+    call coupler % couple(it)
+
+    inquire(file=recvPath, exist=exists)
+    @assertFalse(exists)
+    inquire(file=tallyPath, exist=exists)
+    @assertTrue(exists)
+    inquire(file=sendPath, exist=exists)
+    @assertTrue(exists)
+
+    ! Send file should contain SIGUSR1
+    open(newunit=unit, file=sendPath, status='old', action='read')
+    read(unit,'(A)') line
+    close(unit)
+    correctFile = (trim(line) == 'SIGUSR1')
+    @assertTrue(correctFile)
+
+    ! Reset the files - no need for the recv file
+    open(newunit=unit, file=tallyPath, status='old')
+    close(unit, status='delete')
+    open(newunit=unit, file=sendPath, status='old')
+    close(unit, status='delete')
+
+    it = 10
+    call coupler % couple(it)
+
+    inquire(file=recvPath, exist=exists)
+    @assertFalse(exists)
+    inquire(file=tallyPath, exist=exists)
+    @assertFalse(exists)
+    inquire(file=sendPath, exist=exists)
+    @assertFalse(exists)
+
+    ! Kill coupling admin
+    call coupler % kill()
+
+  end subroutine test_coupling
+
+end module couplingAdmin_iTest