SABER
type_samp Module Reference

Subroutines/functions list. More...

Data Types

type  samp_type
 

Functions/Subroutines

subroutine samp_alloc (samp, mpl, nam, geom)
 Allocation. More...
 
subroutine samp_dealloc (samp)
 Release memory. More...
 
subroutine samp_read (samp, mpl, nam, geom)
 Read. More...
 
subroutine samp_write (samp, mpl, nam)
 Write. More...
 
subroutine samp_write_grids (samp, mpl, nam, geom)
 Write. More...
 
subroutine samp_setup (samp, sname, mpl, rng, nam, geom, ens)
 Setup sampling. More...
 
subroutine samp_compute_mask (samp, mpl, nam, geom, ens)
 Compute mask. More...
 
subroutine samp_compute_c1 (samp, mpl, rng, nam, geom)
 Compute sampling, subset Sc1. More...
 
subroutine samp_compute_c3 (samp, mpl, rng, nam, geom)
 Compute sampling, subset Sc3. More...
 
subroutine samp_compute_c2 (samp, mpl, rng, nam, geom)
 Compute sampling, subset Sc2. More...
 
subroutine samp_compute_mpi_c1au (samp, mpl, nam, geom)
 Compute sampling MPI distribution, subset Sc1, halo A and U. More...
 
subroutine samp_compute_mpi_c2au (samp, mpl, nam, geom)
 Compute sampling MPI distribution, halo A and universe, subset Sc2. More...
 
subroutine samp_compute_mpi_c2b (samp, mpl, rng, nam, geom)
 Compute sampling MPI distribution, halo B. More...
 
subroutine samp_compute_mpi_c0b (samp, mpl, rng, nam, geom)
 Compute MPI distribution, halo B, subset Sc0. More...
 
subroutine samp_compute_mpi_c0c (samp, mpl, rng, nam, geom)
 Compute MPI distribution, halo C, subset Sc0. More...
 
subroutine samp_compute_mpi_d (samp, mpl, nam, geom)
 Compute sampling MPI distribution, halo D. More...
 
subroutine samp_compute_mpi_e (samp, mpl, nam)
 Compute sampling MPI distribution, halo E. More...
 
subroutine samp_diag_filter (samp, mpl, filter_type, rflt, diag_c2a, val_c2a)
 Filter diagnostics. More...
 
subroutine samp_diag_fill (samp, mpl, diag_c2a)
 Fill diagnostics missing values. More...
 
integer function samp_c1_to_c1a (samp, ic1)
 Conversion from global to halo A on subset Sc1. More...
 
integer function samp_c1_to_proc (samp, ic1)
 Conversion from global to processor on subset Sc1. More...
 
integer function samp_c1_to_c1u (samp, ic1)
 Conversion from global to universe on subset Sc1. More...
 
integer function samp_c2_to_c2a (samp, ic2)
 Conversion from global to halo A on subset Sc2. More...
 
integer function samp_c2_to_proc (samp, ic2)
 Conversion from global to processor on subset Sc2. More...
 
integer function samp_c2_to_c2u (samp, ic2)
 Conversion from global to universe on subset Sc2. More...
 

Detailed Description

Subroutines/functions list.

Instrumentation functions Sampling derived type

Function/Subroutine Documentation

◆ samp_alloc()

subroutine type_samp::samp_alloc ( class(samp_type), intent(inout)  samp,
type(mpl_type), intent(inout)  mpl,
type(nam_type), intent(in)  nam,
type(geom_type), intent(in)  geom 
)
private

Allocation.

Parameters
[in,out]sampSampling
[in,out]mplMPI data
[in]namNamelist
[in]geomGeometry

Definition at line 203 of file type_samp.F90.

◆ samp_c1_to_c1a()

integer function type_samp::samp_c1_to_c1a ( class(samp_type), intent(in)  samp,
integer, intent(in)  ic1 
)
private

Conversion from global to halo A on subset Sc1.

Parameters
[in]sampSampling
[in]ic1Global index

Definition at line 2803 of file type_samp.F90.

◆ samp_c1_to_c1u()

integer function type_samp::samp_c1_to_c1u ( class(samp_type), intent(in)  samp,
integer, intent(in)  ic1 
)
private

Conversion from global to universe on subset Sc1.

Parameters
[in]sampSampling
[in]ic1Global index

Definition at line 2861 of file type_samp.F90.

◆ samp_c1_to_proc()

integer function type_samp::samp_c1_to_proc ( class(samp_type), intent(in)  samp,
integer, intent(in)  ic1 
)
private

Conversion from global to processor on subset Sc1.

Parameters
[in]sampSampling
[in]ic1Global index

Definition at line 2832 of file type_samp.F90.

◆ samp_c2_to_c2a()

integer function type_samp::samp_c2_to_c2a ( class(samp_type), intent(in)  samp,
integer, intent(in)  ic2 
)
private

Conversion from global to halo A on subset Sc2.

Parameters
[in]sampSampling
[in]ic2Global index

Definition at line 2890 of file type_samp.F90.

◆ samp_c2_to_c2u()

integer function type_samp::samp_c2_to_c2u ( class(samp_type), intent(in)  samp,
integer, intent(in)  ic2 
)
private

Conversion from global to universe on subset Sc2.

Parameters
[in]sampSampling
[in]ic2Global index

Definition at line 2948 of file type_samp.F90.

◆ samp_c2_to_proc()

integer function type_samp::samp_c2_to_proc ( class(samp_type), intent(in)  samp,
integer, intent(in)  ic2 
)
private

Conversion from global to processor on subset Sc2.

Parameters
[in]sampSampling
[in]ic2Global index

Definition at line 2919 of file type_samp.F90.

◆ samp_compute_c1()

subroutine type_samp::samp_compute_c1 ( class(samp_type), intent(inout)  samp,
type(mpl_type), intent(inout)  mpl,
type(rng_type), intent(inout)  rng,
type(nam_type), intent(inout)  nam,
type(geom_type), intent(in)  geom 
)
private

Compute sampling, subset Sc1.

Parameters
[in,out]sampSampling
[in,out]mplMPI data
[in,out]rngRandom number generator
[in,out]namNamelist
[in]geomGeometry

Definition at line 1187 of file type_samp.F90.

◆ samp_compute_c2()

subroutine type_samp::samp_compute_c2 ( class(samp_type), intent(inout)  samp,
type(mpl_type), intent(inout)  mpl,
type(rng_type), intent(inout)  rng,
type(nam_type), intent(inout)  nam,
type(geom_type), intent(in)  geom 
)
private

Compute sampling, subset Sc2.

Parameters
[in,out]sampSampling
[in,out]mplMPI data
[in,out]rngRandom number generator
[in,out]namNamelist
[in]geomGeometry

Definition at line 1655 of file type_samp.F90.

◆ samp_compute_c3()

subroutine type_samp::samp_compute_c3 ( class(samp_type), intent(inout)  samp,
type(mpl_type), intent(inout)  mpl,
type(rng_type), intent(inout)  rng,
type(nam_type), intent(in)  nam,
type(geom_type), intent(in)  geom 
)
private

Compute sampling, subset Sc3.

Parameters
[in,out]sampSampling
[in,out]mplMPI data
[in,out]rngRandom number generator
[in]namNamelist
[in]geomGeometry

Definition at line 1448 of file type_samp.F90.

◆ samp_compute_mask()

subroutine type_samp::samp_compute_mask ( class(samp_type), intent(inout)  samp,
type(mpl_type), intent(inout)  mpl,
type(nam_type), intent(in)  nam,
type(geom_type), intent(in)  geom,
type(ens_type), intent(inout)  ens 
)
private

Compute mask.

Parameters
[in,out]sampSampling
[in,out]mplMPI data
[in]namNamelist
[in]geomGeometry
[in,out]ensEnsemble

Definition at line 1028 of file type_samp.F90.

◆ samp_compute_mpi_c0b()

subroutine type_samp::samp_compute_mpi_c0b ( class(samp_type), intent(inout)  samp,
type(mpl_type), intent(inout)  mpl,
type(rng_type), intent(inout)  rng,
type(nam_type), intent(in)  nam,
type(geom_type), intent(in)  geom 
)
private

Compute MPI distribution, halo B, subset Sc0.

Parameters
[in,out]sampSampling
[in,out]mplMPI data
[in,out]rngRandom number generator
[in]namNamelist
[in]geomGeometry

Definition at line 2077 of file type_samp.F90.

◆ samp_compute_mpi_c0c()

subroutine type_samp::samp_compute_mpi_c0c ( class(samp_type), intent(inout)  samp,
type(mpl_type), intent(inout)  mpl,
type(rng_type), intent(inout)  rng,
type(nam_type), intent(in)  nam,
type(geom_type), intent(in)  geom 
)
private

Compute MPI distribution, halo C, subset Sc0.

Parameters
[in,out]sampSampling
[in,out]mplMPI data
[in,out]rngRandom number generator
[in]namNamelist
[in]geomGeometry

Definition at line 2198 of file type_samp.F90.

◆ samp_compute_mpi_c1au()

subroutine type_samp::samp_compute_mpi_c1au ( class(samp_type), intent(inout)  samp,
type(mpl_type), intent(inout)  mpl,
type(nam_type), intent(inout)  nam,
type(geom_type), intent(in)  geom 
)
private

Compute sampling MPI distribution, subset Sc1, halo A and U.

Parameters
[in,out]sampSampling
[in,out]mplMPI data
[in,out]namNamelist
[in]geomGeometry

Definition at line 1757 of file type_samp.F90.

◆ samp_compute_mpi_c2au()

subroutine type_samp::samp_compute_mpi_c2au ( class(samp_type), intent(inout)  samp,
type(mpl_type), intent(inout)  mpl,
type(nam_type), intent(in)  nam,
type(geom_type), intent(in)  geom 
)
private

Compute sampling MPI distribution, halo A and universe, subset Sc2.

Parameters
[in,out]sampSampling
[in,out]mplMPI data
[in]namNamelist
[in]geomGeometry

Definition at line 1832 of file type_samp.F90.

◆ samp_compute_mpi_c2b()

subroutine type_samp::samp_compute_mpi_c2b ( class(samp_type), intent(inout)  samp,
type(mpl_type), intent(inout)  mpl,
type(rng_type), intent(inout)  rng,
type(nam_type), intent(in)  nam,
type(geom_type), intent(in)  geom 
)
private

Compute sampling MPI distribution, halo B.

Parameters
[in,out]sampSampling
[in,out]mplMPI data
[in,out]rngRandom number generator
[in]namNamelist
[in]geomGeometry

Definition at line 1969 of file type_samp.F90.

◆ samp_compute_mpi_d()

subroutine type_samp::samp_compute_mpi_d ( class(samp_type), intent(inout)  samp,
type(mpl_type), intent(inout)  mpl,
type(nam_type), intent(in)  nam,
type(geom_type), intent(in)  geom 
)
private

Compute sampling MPI distribution, halo D.

Parameters
[in,out]sampSampling
[in,out]mplMPI data
[in]namNamelist
[in]geomGeometry

Definition at line 2331 of file type_samp.F90.

◆ samp_compute_mpi_e()

subroutine type_samp::samp_compute_mpi_e ( class(samp_type), intent(inout)  samp,
type(mpl_type), intent(inout)  mpl,
type(nam_type), intent(in)  nam 
)
private

Compute sampling MPI distribution, halo E.

Parameters
[in,out]sampSampling
[in,out]mplMPI data
[in]namNamelist

Definition at line 2459 of file type_samp.F90.

◆ samp_dealloc()

subroutine type_samp::samp_dealloc ( class(samp_type), intent(inout)  samp)
private

Release memory.

Parameters
[in,out]sampSampling

Definition at line 245 of file type_samp.F90.

◆ samp_diag_fill()

subroutine type_samp::samp_diag_fill ( class(samp_type), intent(in)  samp,
type(mpl_type), intent(inout)  mpl,
real(kind_real), dimension(samp%nc2a), intent(inout)  diag_c2a 
)
private

Fill diagnostics missing values.

Parameters
[in]sampSampling
[in,out]mplMPI data
[in,out]diag_c2aFiltered diagnostic

Definition at line 2745 of file type_samp.F90.

◆ samp_diag_filter()

subroutine type_samp::samp_diag_filter ( class(samp_type), intent(in)  samp,
type(mpl_type), intent(inout)  mpl,
character(len=*), intent(in)  filter_type,
real(kind_real), intent(in)  rflt,
real(kind_real), dimension(samp%nc2a), intent(inout)  diag_c2a,
real(kind_real), dimension(samp%nc2a), intent(in), optional  val_c2a 
)
private

Filter diagnostics.

Parameters
[in]sampSampling
[in,out]mplMPI data
[in]filter_typeFilter type
[in]rfltFilter support radius
[in,out]diag_c2aFiltered diagnostic
[in]val_c2aUseful value for filtering

Definition at line 2573 of file type_samp.F90.

◆ samp_read()

subroutine type_samp::samp_read ( class(samp_type), intent(inout)  samp,
type(mpl_type), intent(inout)  mpl,
type(nam_type), intent(inout)  nam,
type(geom_type), intent(in)  geom 
)
private

Read.

Parameters
[in,out]sampSampling
[in,out]mplMPI data
[in,out]namNamelist
[in]geomGeometry

Definition at line 355 of file type_samp.F90.

◆ samp_setup()

subroutine type_samp::samp_setup ( class(samp_type), intent(inout)  samp,
character(len=*), intent(in)  sname,
type(mpl_type), intent(inout)  mpl,
type(rng_type), intent(inout)  rng,
type(nam_type), intent(inout)  nam,
type(geom_type), intent(in)  geom,
type(ens_type), intent(inout)  ens 
)
private

Setup sampling.

Parameters
[in,out]sampSampling
[in]snameSampling name
[in,out]mplMPI data
[in,out]rngRandom number generator
[in,out]namNamelist
[in]geomGeometry
[in,out]ensEnsemble

Definition at line 808 of file type_samp.F90.

◆ samp_write()

subroutine type_samp::samp_write ( class(samp_type), intent(inout)  samp,
type(mpl_type), intent(inout)  mpl,
type(nam_type), intent(in)  nam 
)
private

Write.

Parameters
[in,out]sampSampling
[in,out]mplMPI data
[in]namNamelist

Definition at line 534 of file type_samp.F90.

◆ samp_write_grids()

subroutine type_samp::samp_write_grids ( class(samp_type), intent(in)  samp,
type(mpl_type), intent(inout)  mpl,
type(nam_type), intent(in)  nam,
type(geom_type), intent(in)  geom 
)
private

Write.

Parameters
[in]sampSampling
[in,out]mplMPI data
[in]namNamelist
[in]geomGeometry

Definition at line 593 of file type_samp.F90.