Functions/Subroutines
subroutine, public	white_noise1d (ng, model, rscheme, imin, imax, lbi, ubi, rmin, rmax, r)

subroutine, public	white_noise2d (ng, model, gtype, rscheme, imin, imax, jmin, jmax, lbi, ubi, lbj, ubj, rmin, rmax, r)

subroutine, public	white_noise2d_bry (ng, tile, model, boundary, rscheme, imin, imax, lbij, ubij, rmin, rmax, r)

subroutine, public	white_noise3d (ng, model, gtype, rscheme, imin, imax, jmin, jmax, lbi, ubi, lbj, ubj, lbk, ubk, rmin, rmax, r)

subroutine, public	white_noise3d_bry (ng, tile, model, boundary, rscheme, imin, imax, lbij, ubij, lbk, ubk, rmin, rmax, r)

Function/Subroutine Documentation

◆ white_noise1d()

subroutine, public white_noise_mod::white_noise1d	(	integer, intent(in)	ng,
		integer, intent(in)	model,
		integer, intent(in)	rscheme,
		integer, intent(in)	imin,
		integer, intent(in)	imax,
		integer, intent(in)	lbi,
		integer, intent(in)	ubi,
		real(r8), intent(out)	rmin,
		real(r8), intent(out)	rmax,
		real(r8), dimension(lbi:), intent(out)	r )

Definition at line 49 of file white_noise.F.

!***********************************************************************
!
      USE mod_param
      USE mod_parallel
      USE mod_scalars
!
      USE nrutil, ONLY : gasdev
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng, model, Rscheme
      integer, intent(in) :: Imin, Imax, LBi, UBi
 
      real(r8), intent(out) :: Rmin, Rmax
 
#ifdef ASSUMED_SHAPE
      real(r8), intent(out) :: R(LBi:)
#else
      real(r8), intent(out) :: R(LBi:UBi)
#endif
!
!  Local variable declarations.
!
      integer :: i, ic
 
      real(r8), parameter :: fac = 2.0_r8 * 1.73205080756887720_r8
 
      real(r8), dimension((UBi-LBi+1)) :: random
!
!-----------------------------------------------------------------------
!  Generate an array of random numbers.
!-----------------------------------------------------------------------
!
!  Initialize output array.
!
      DO i=lbi,ubi
        r(i)=0.0_r8
      END DO
!
!  F90 intrinsic pseudorandom numbers with an uniform distribution
!  over the range 0 <= R < 1.
!
      IF (rscheme.eq.0) THEN
        CALL random_number (r(lbi:))
!
!  Scale (fac=2*SQRT(3)) the random number to insure the expectation
!  mean to be approximately zero, E(R)=0, and the expectation variance
!  to be approximately unity, E(R^2)=1 (Bennett, 2002; book page 72).
!
!  Recall that,
!
!      E(R) = sum[R f(R)]
!
!  where F(R) is the random variable probability distribution.
!
        DO i=imin,imax
          r(i)=fac*(r(i)-0.5_r8)
        END DO
        rmin=minval(r)
        rmax=maxval(r)
!
!  Random deviates with a Gaussian (normal) distribuiton over the
!  range from -1 to 1.
!
      ELSE IF (rscheme.eq.1) THEN
        IF (master) THEN
          CALL gasdev (random)
          rmin=minval(random)
          rmax=maxval(random)
        END IF
        ic=0
        DO i=imin,imax
          ic=ic+1
          r(i)=random(ic)
        END DO
      END IF
 
      RETURN

References mod_parallel::master.

◆ white_noise2d()

subroutine, public white_noise_mod::white_noise2d	(	integer, intent(in)	ng,
		integer, intent(in)	model,
		integer, intent(in)	gtype,
		integer, intent(in)	rscheme,
		integer, intent(in)	imin,
		integer, intent(in)	imax,
		integer, intent(in)	jmin,
		integer, intent(in)	jmax,
		integer, intent(in)	lbi,
		integer, intent(in)	ubi,
		integer, intent(in)	lbj,
		integer, intent(in)	ubj,
		real(r8), intent(out)	rmin,
		real(r8), intent(out)	rmax,
		real(r8), dimension(lbi:ubi,lbj:ubj), intent(out)	r )

Definition at line 134 of file white_noise.F.

!***********************************************************************
!
      USE mod_param
      USE mod_parallel
      USE mod_scalars
!
#ifdef DISTRIBUTE
      USE distribute_mod, ONLY : mp_scatter2d
#endif
      USE nrutil, ONLY : gasdev
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng, model, gtype, Rscheme
      integer, intent(in) :: Imin, Imax, Jmin, Jmax
      integer, intent(in) :: LBi, UBi, LBj, UBj
 
      real(r8), intent(out) :: Rmin, Rmax
 
      real(r8), intent(out) :: R(LBi:UBi,LBj:UBj)
!
!  Local variable declarations.
!
      integer :: Npts, i, ic, j
 
      real(r8), parameter :: fac = 2.0_r8 * 1.73205080756887720_r8
 
      real(r8), allocatable :: random(:)
!
!-----------------------------------------------------------------------
!  Generate an array of random numbers.
!-----------------------------------------------------------------------
!
!  Initialize output array.
!
      DO j=lbj,ubj
        DO i=lbi,ubi
          r(i,j)=0.0_r8
        END DO
      END DO
!
!  F90 intrinsic pseudorandom numbers with an uniform distribution
!  over the range 0 <= R < 1.
!
      IF (rscheme.eq.0) THEN
        CALL random_number (r(lbi:,lbj:))
!
!  Scale (fac=2*SQRT(3)) the random number to insure the expectation
!  mean to be approximately zero, E(R)=0, and the expectation variance
!  to be approximately unity, E(R^2)=1 (Bennett, 2002; book page 72).
!
!  Recall that,
!
!      E(R) = sum[R f(R)]
!
!  where F(R) is the random variable probability distribution.
!
        DO j=jmin,jmax
          DO i=imin,imax
            r(i,j)=fac*(r(i,j)-0.5_r8)
          END DO
        END DO
        rmin=minval(r)
        rmax=maxval(r)
!
!  Random deviates with a Gaussian (normal) distribuiton with zero
!  mean and unit variance.
!
      ELSE IF (rscheme.eq.1) THEN
        npts=(lm(ng)+2)*(mm(ng)+2)
        IF (.not.allocated(random)) THEN
          allocate ( random(npts+2) )
        END IF
        IF (master) THEN
          CALL gasdev (random)
          rmin=random(1)
          rmax=random(1)
          DO ic=1,npts
            rmin=min(rmin,random(ic))
            rmax=max(rmax,random(ic))
          END DO
        END IF
#ifdef DISTRIBUTE
        npts=SIZE(random)
        CALL mp_scatter2d (ng, model, lbi, ubi, lbj, ubj,               &
     &                     nghostpoints, gtype, rmin, rmax,             &
# if defined READ_WATER && defined MASKING
     &                     (lm(ng)+2)*(mm(ng)+2),                       &
     &                     scalars(ng)%IJwater(:,gtype),                &
# endif
     &                     npts, random, r)
#else
        ic=0
        DO j=jmin,jmax
          DO i=imin,imax
            ic=ic+1
            r(i,j)=random(ic)
          END DO
        END DO
#endif
        IF (allocated(random)) THEN
          deallocate (random)
        END IF
      END IF
 
      RETURN

References mod_param::lm, mod_parallel::master, mod_param::mm, distribute_mod::mp_scatter2d(), mod_param::nghostpoints, and mod_scalars::scalars.

Referenced by random_ic_mod::random_ic_tile(), and normalization_mod::randomization_tile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ white_noise2d_bry()

subroutine, public white_noise_mod::white_noise2d_bry	(	integer, intent(in)	ng,
		integer, intent(in)	tile,
		integer, intent(in)	model,
		integer, intent(in)	boundary,
		integer, intent(in)	rscheme,
		integer, intent(in)	imin,
		integer, intent(in)	imax,
		integer, intent(in)	lbij,
		integer, intent(in)	ubij,
		real(r8), intent(out)	rmin,
		real(r8), intent(out)	rmax,
		real(r8), dimension(lbij:), intent(out)	r )

Definition at line 248 of file white_noise.F.

!***********************************************************************
!
      USE mod_param
      USE mod_parallel
      USE mod_scalars
!
#ifdef DISTRIBUTE
      USE distribute_mod, ONLY : mp_bcastf
      USE mp_exchange_mod, ONLY : mp_exchange2d_bry
#endif
      USE nrutil, ONLY : gasdev
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng, tile, model, boundary, Rscheme
      integer, intent(in) :: Imin, Imax
      integer, intent(in) :: LBij, UBij
 
      real(r8), intent(out) :: Rmin, Rmax
 
#ifdef ASSUMED_SHAPE
      real(r8), intent(out) :: R(LBij:)
#else
      real(r8), intent(out) :: R(LBij:UBij)
#endif
!
!  Local variable declarations.
!
      integer :: Ioff, i, ic
 
      real(r8), parameter :: fac = 2.0_r8 * 1.73205080756887720_r8
 
      real(r8), dimension(UBij-LBij+1) :: random
!
!-----------------------------------------------------------------------
!  Generate an array of random numbers.
!-----------------------------------------------------------------------
!
!  Initialize output array.
!
      DO i=lbij,ubij
        r(i)=0.0_r8
      END DO
!
!  F90 intrinsic pseudorandom numbers with an uniform distribution
!  over the range 0 <= R < 1.
!
      IF (rscheme.eq.0) THEN
        CALL random_number (r(lbij:))
!
!  Scale (fac=2*SQRT(3)) the random number to insure the expectation
!  mean to be approximately zero, E(R)=0, and the expectation variance
!  to be approximately unity, E(R^2)=1 (Bennett, 2002; book page 72).
!
!  Recall that,
!
!      E(R) = sum[R f(R)]
!
!  where F(R) is the random variable probability distribution.
!
        DO i=imin,imax
          r(i)=fac*(r(i)-0.5_r8)
        END DO
        rmin=minval(r)
        rmax=maxval(r)
!
!  Random deviates with a Gaussian (normal) distribuiton with zero
!  mean and unit variance.
!
      ELSE IF (rscheme.eq.1) THEN
        IF (master) THEN
          CALL gasdev (random)
        END IF
#ifdef DISTRIBUTE
        CALL mp_bcastf (ng, model, random)
#endif
        rmin=minval(random)
        rmax=maxval(random)
 
        ioff=1-lbij
        DO i=imin,imax
          ic=i+ioff
          r(i)=random(ic)
        END DO
#ifdef DISTRIBUTE
        CALL mp_exchange2d_bry (ng, tile, model, 1, boundary,           &
     &                          lbij, ubij,                             &
     &                          nghostpoints,                           &
     &                          ewperiodic(ng), nsperiodic(ng),         &
     &                          r)
#endif
      END IF
 
      RETURN

References mod_scalars::ewperiodic, mod_parallel::master, mp_exchange_mod::mp_exchange2d_bry(), mod_param::nghostpoints, and mod_scalars::nsperiodic.

Referenced by random_ic_mod::random_ic_tile(), and normalization_mod::randomization_tile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ white_noise3d()

subroutine, public white_noise_mod::white_noise3d	(	integer, intent(in)	ng,
		integer, intent(in)	model,
		integer, intent(in)	gtype,
		integer, intent(in)	rscheme,
		integer, intent(in)	imin,
		integer, intent(in)	imax,
		integer, intent(in)	jmin,
		integer, intent(in)	jmax,
		integer, intent(in)	lbi,
		integer, intent(in)	ubi,
		integer, intent(in)	lbj,
		integer, intent(in)	ubj,
		integer, intent(in)	lbk,
		integer, intent(in)	ubk,
		real(r8), intent(out)	rmin,
		real(r8), intent(out)	rmax,
		real(r8), dimension(lbi:,lbj:,lbk:), intent(out)	r )

Definition at line 352 of file white_noise.F.

!***********************************************************************
!
      USE mod_param
      USE mod_parallel
      USE mod_scalars
!
# ifdef DISTRIBUTE
      USE distribute_mod, ONLY : mp_scatter3d
# endif
      USE nrutil, ONLY : gasdev
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng, model, gtype, Rscheme
      integer, intent(in) :: Imin, Imax, Jmin, Jmax
      integer, intent(in) :: LBi, UBi, LBj, UBj, LBk, UBk
 
      real(r8), intent(out) :: Rmin, Rmax
 
# ifdef ASSUMED_SHAPE
      real(r8), intent(out) :: R(LBi:,LBj:,LBk:)
# else
      real(r8), intent(out) :: R(LBi:UBi,LBj:UBj,LBk:UBk)
# endif
!
!  Local variable declarations.
!
      integer :: Npts, i, ic, j, k
 
      real(r8), parameter :: fac = 2.0_r8 * 1.73205080756887720_r8
 
      real(r8), allocatable :: random(:)
!
!-----------------------------------------------------------------------
!  Generate an array of random numbers.
!-----------------------------------------------------------------------
!
!  Initialize output array.
!
      DO k=lbk,ubk
        DO j=lbj,ubj
          DO i=lbi,ubi
            r(i,j,k)=0.0_r8
          END DO
        END DO
      END DO
!
!  F90 intrinsic pseudorandom numbers with an uniform distribution
!  over the range 0 <= R < 1.
!
      IF (rscheme.eq.0) THEN
        CALL random_number (r(lbi:,lbj:,lbk:))
!
!  Scale (fac=2*SQRT(3)) the random number to insure the expectation
!  mean to be approximately zero, E(R)=0, and the expectation variance
!  to be approximately unity, E(R^2)=1.
!
!  Recall that,
!
!      E(R) = sum[R f(R)]
!
!  where F(R) is the random variable probability distribution
!
        DO k=lbk,ubk
          DO j=jmin,jmax
            DO i=imin,imax
              r(i,j,k)=fac*(r(i,j,k)-0.5_r8)
            END DO
          END DO
        END DO
        rmin=minval(r)
        rmax=maxval(r)
!
!  Random deviates with a Gaussian (normal) distribution with zero
!  mean and unit variance.
!
      ELSE IF (rscheme.eq.1) THEN
        npts=(lm(ng)+2)*(mm(ng)+2)*(ubk-lbk+1)
        IF (.not.allocated(random)) THEN
          allocate ( random(npts+2) )
        END IF
        IF (master) THEN
          CALL gasdev (random)
          rmin=random(1)
          rmax=random(1)
          DO ic=1,npts
            rmin=min(rmin,random(ic))
            rmax=max(rmax,random(ic))
          END DO
        END IF
# ifdef DISTRIBUTE
        npts=SIZE(random)
        CALL mp_scatter3d (ng, model, lbi, ubi, lbj, ubj, lbk, ubk,     &
     &                     nghostpoints, gtype, rmin, rmax,             &
#  if defined READ_WATER && defined MASKING
     &                     (lm(ng)+2)*(mm(ng)+2),                       &
     &                     scalars(ng)%IJwater(:,gtype),                &
#  endif
     &                     npts, random, r)
# else
        ic=0
        DO k=lbk,ubk
          DO j=jmin,jmax
            DO i=imin,imax
              ic=ic+1
              r(i,j,k)=random(ic)
            END DO
          END DO
        END DO
# endif
        IF (allocated(random)) THEN
          deallocate (random)
        END IF
      END IF
 
      RETURN

References mod_param::lm, mod_parallel::master, mod_param::mm, distribute_mod::mp_scatter3d(), mod_param::nghostpoints, and mod_scalars::scalars.

Referenced by random_ic_mod::random_ic_tile(), and normalization_mod::randomization_tile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ white_noise3d_bry()

subroutine, public white_noise_mod::white_noise3d_bry	(	integer, intent(in)	ng,
		integer, intent(in)	tile,
		integer, intent(in)	model,
		integer, intent(in)	boundary,
		integer, intent(in)	rscheme,
		integer, intent(in)	imin,
		integer, intent(in)	imax,
		integer, intent(in)	lbij,
		integer, intent(in)	ubij,
		integer, intent(in)	lbk,
		integer, intent(in)	ubk,
		real(r8), intent(out)	rmin,
		real(r8), intent(out)	rmax,
		real(r8), dimension(lbij:,lbk:), intent(out)	r )

Definition at line 476 of file white_noise.F.

!***********************************************************************
!
      USE mod_param
      USE mod_parallel
      USE mod_scalars
!
# ifdef DISTRIBUTE
      USE distribute_mod, ONLY : mp_bcastf
      USE mp_exchange_mod, ONLY : mp_exchange3d_bry
# endif
      USE nrutil, ONLY : gasdev
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng, tile, model, boundary, Rscheme
      integer, intent(in) :: Imin, Imax
      integer, intent(in) :: LBij, UBij, LBk, UBk
 
      real(r8), intent(out) :: Rmin, Rmax
 
# ifdef ASSUMED_SHAPE
      real(r8), intent(out) :: R(LBij:,LBk:)
# else
      real(r8), intent(out) :: R(LBij:UBij,LBk:UBk)
# endif
!
!  Local variable declarations.
!
      integer :: Ilen, Ioff, i, ic, k, kc
 
      real(r8), parameter :: fac = 2.0_r8 * 1.73205080756887720_r8
 
      real(r8), dimension((UBij-LBij+1)*(UBk-LBk+1)) :: random
!
!-----------------------------------------------------------------------
!  Generate an array of random numbers.
!-----------------------------------------------------------------------
!
!  Initialize output array.
!
      DO k=lbk,ubk
        DO i=lbij,ubij
          r(i,k)=0.0_r8
        END DO
      END DO
!
!  F90 intrinsic pseudorandom numbers with an uniform distribution
!  over the range 0 <= R < 1.
!
      IF (rscheme.eq.0) THEN
        CALL random_number (r(lbij:,lbk:))
!
!  Scale (fac=2*SQRT(3)) the random number to insure the expectation
!  mean to be approximately zero, E(R)=0, and the expectation variance
!  to be approximately unity, E(R^2)=1 (Bennett, 2002; book page 72).
!
!  Recall that,
!
!      E(R) = sum[R f(R)]
!
!  where F(R) is the random variable probability distribution.
!
        DO k=lbk,ubk
          DO i=imin,imax
            r(i,k)=fac*(r(i,k)-0.5_r8)
          END DO
        END DO
        rmin=minval(r)
        rmax=maxval(r)
!
!  Random deviates with a Gaussian (normal) distribuiton with zero
!  mean and unit variance.
!
      ELSE IF (rscheme.eq.1) THEN
        IF (master) THEN
          CALL gasdev (random)
        END IF
# ifdef DISTRIBUTE
        CALL mp_bcastf (ng, model, random)
# endif
        rmin=minval(random)
        rmax=maxval(random)
 
        ilen=ubij-lbij+1
        ioff=1-lbij
 
        DO k=lbk,ubk
          kc=(k-lbk)*ilen
          DO i=imin,imax
            ic=i+ioff+kc
            r(i,k)=random(ic)
          END DO
        END DO
# ifdef DISTRIBUTE
        CALL mp_exchange3d_bry (ng, tile, model, 1, boundary,           &
     &                          lbij, ubij, lbk, ubk,                   &
     &                          nghostpoints,                           &
     &                          ewperiodic(ng), nsperiodic(ng),         &
     &                          r)
# endif
      END IF
 
      RETURN

References mod_scalars::ewperiodic, mod_parallel::master, mp_exchange_mod::mp_exchange3d_bry(), mod_param::nghostpoints, and mod_scalars::nsperiodic.

Referenced by random_ic_mod::random_ic_tile(), and normalization_mod::randomization_tile().

Here is the call graph for this function:

Here is the caller graph for this function:

Functions/Subroutines

Function/Subroutine Documentation

◆ white_noise1d()

◆ white_noise2d()

◆ white_noise2d_bry()

◆ white_noise3d()

◆ white_noise3d_bry()