FV3 Bundle
type_nicas Module Reference

Data Types

type  nicas_type
 

Functions/Subroutines

subroutine nicas_alloc (nicas, mpl, nam, bpar, prefix)
 
subroutine nicas_dealloc (nicas, nam, geom, bpar)
 
subroutine nicas_read (nicas, mpl, nam, geom, bpar)
 
subroutine nicas_write (nicas, mpl, nam, geom, bpar)
 
subroutine nicas_write_mpi_summary (nicas, mpl, nam, geom, bpar)
 
subroutine nicas_run_nicas (nicas, mpl, rng, nam, geom, bpar, cmat)
 
subroutine nicas_run_nicas_tests (nicas, mpl, rng, nam, geom, bpar, io, cmat, ens)
 
subroutine nicas_alloc_cv (nicas, bpar, cv, getsizeonly)
 
subroutine nicas_random_cv (nicas, rng, bpar, cv)
 
subroutine nicas_apply (nicas, mpl, nam, geom, bpar, fld)
 
subroutine nicas_apply_from_sqrt (nicas, mpl, nam, geom, bpar, fld)
 
subroutine nicas_apply_sqrt (nicas, mpl, nam, geom, bpar, cv, fld)
 
subroutine nicas_apply_sqrt_ad (nicas, mpl, nam, geom, bpar, fld, cv)
 
subroutine nicas_randomize (nicas, mpl, rng, nam, geom, bpar, ne, ens)
 
subroutine nicas_apply_bens (nicas, mpl, nam, geom, bpar, ens, fld)
 
subroutine nicas_apply_bens_noloc (nicas, mpl, nam, geom, ens, fld)
 
subroutine nicas_test_adjoint (nicas, mpl, rng, nam, geom, bpar, ens)
 
subroutine nicas_test_sqrt (nicas, mpl, rng, nam, geom, bpar, io, cmat, ens)
 
subroutine nicas_test_dirac (nicas, mpl, nam, geom, bpar, io, ens)
 
subroutine nicas_test_randomization (nicas, mpl, rng, nam, geom, bpar, io)
 
subroutine nicas_test_consistency (nicas, mpl, rng, nam, geom, bpar, io, cmat)
 
subroutine nicas_test_optimality (nicas, mpl, rng, nam, geom, bpar, io)
 
subroutine define_test_vectors (mpl, rng, nam, geom, ntest, fld)
 

Variables

integer, parameter ne_rand = 150
 
integer, parameter nfac = 10
 
integer, parameter ntest = 100
 
logical, parameter pos_def_test = .false.
 

Function/Subroutine Documentation

◆ define_test_vectors()

subroutine type_nicas::define_test_vectors ( type(mpl_type), intent(in)  mpl,
type(rng_type), intent(inout)  rng,
type(nam_type), intent(in)  nam,
type(geom_type), intent(in)  geom,
integer, intent(in)  ntest,
real(kind_real), dimension(geom%nc0a,geom%nl0,nam%nv,nam%nts,ntest), intent(out)  fld 
)
private

Definition at line 2239 of file type_nicas.F90.

Here is the caller graph for this function:

◆ nicas_alloc()

subroutine type_nicas::nicas_alloc ( class(nicas_type), intent(inout)  nicas,
type(mpl_type), intent(in)  mpl,
type(nam_type), intent(in)  nam,
type(bpar_type), intent(in)  bpar,
character(len=*), intent(in)  prefix 
)
private

Definition at line 78 of file type_nicas.F90.

◆ nicas_alloc_cv()

subroutine type_nicas::nicas_alloc_cv ( class(nicas_type), intent(in)  nicas,
type(bpar_type), intent(in)  bpar,
type(cv_type), intent(inout)  cv,
logical, intent(in), optional  getsizeonly 
)
private

Definition at line 674 of file type_nicas.F90.

◆ nicas_apply()

subroutine type_nicas::nicas_apply ( class(nicas_type), intent(in)  nicas,
type(mpl_type), intent(in)  mpl,
type(nam_type), intent(in), target  nam,
type(geom_type), intent(in), target  geom,
type(bpar_type), intent(in), target  bpar,
real(kind_real), dimension(geom%nc0a,geom%nl0,nam%nv,nam%nts), intent(inout)  fld 
)
private

Definition at line 753 of file type_nicas.F90.

◆ nicas_apply_bens()

subroutine type_nicas::nicas_apply_bens ( class(nicas_type), intent(in)  nicas,
type(mpl_type), intent(in)  mpl,
type(nam_type), intent(in), target  nam,
type(geom_type), intent(in), target  geom,
type(bpar_type), intent(in), target  bpar,
type(ens_type), intent(in)  ens,
real(kind_real), dimension(geom%nc0a,geom%nl0,nam%nv,nam%nts), intent(inout)  fld 
)
private

Definition at line 1543 of file type_nicas.F90.

◆ nicas_apply_bens_noloc()

subroutine type_nicas::nicas_apply_bens_noloc ( class(nicas_type), intent(in)  nicas,
type(mpl_type), intent(in)  mpl,
type(nam_type), intent(in), target  nam,
type(geom_type), intent(in), target  geom,
type(ens_type), intent(in)  ens,
real(kind_real), dimension(geom%nc0a,geom%nl0,nam%nv,nam%nts), intent(inout)  fld 
)
private

Definition at line 1602 of file type_nicas.F90.

◆ nicas_apply_from_sqrt()

subroutine type_nicas::nicas_apply_from_sqrt ( class(nicas_type), intent(in)  nicas,
type(mpl_type), intent(in)  mpl,
type(nam_type), intent(in), target  nam,
type(geom_type), intent(in), target  geom,
type(bpar_type), intent(in), target  bpar,
real(kind_real), dimension(geom%nc0a,geom%nl0,nam%nv,nam%nts), intent(inout)  fld 
)
private

Definition at line 1008 of file type_nicas.F90.

◆ nicas_apply_sqrt()

subroutine type_nicas::nicas_apply_sqrt ( class(nicas_type), intent(in)  nicas,
type(mpl_type), intent(in)  mpl,
type(nam_type), intent(in), target  nam,
type(geom_type), intent(in), target  geom,
type(bpar_type), intent(in), target  bpar,
type(cv_type), intent(in)  cv,
real(kind_real), dimension(geom%nc0a,geom%nl0,nam%nv,nam%nts), intent(out)  fld 
)
private

Definition at line 1050 of file type_nicas.F90.

Here is the call graph for this function:

◆ nicas_apply_sqrt_ad()

subroutine type_nicas::nicas_apply_sqrt_ad ( class(nicas_type), intent(in)  nicas,
type(mpl_type), intent(in)  mpl,
type(nam_type), intent(in), target  nam,
type(geom_type), intent(in), target  geom,
type(bpar_type), intent(in), target  bpar,
real(kind_real), dimension(geom%nc0a,geom%nl0,nam%nv,nam%nts), intent(in)  fld,
type(cv_type), intent(out)  cv 
)
private

Definition at line 1251 of file type_nicas.F90.

Here is the call graph for this function:

◆ nicas_dealloc()

subroutine type_nicas::nicas_dealloc ( class(nicas_type), intent(inout)  nicas,
type(nam_type), intent(in)  nam,
type(geom_type), intent(in)  geom,
type(bpar_type), intent(in)  bpar 
)
private

Definition at line 117 of file type_nicas.F90.

◆ nicas_random_cv()

subroutine type_nicas::nicas_random_cv ( class(nicas_type), intent(in)  nicas,
type(rng_type), intent(inout)  rng,
type(bpar_type), intent(in)  bpar,
type(cv_type), intent(out)  cv 
)
private

Definition at line 726 of file type_nicas.F90.

◆ nicas_randomize()

subroutine type_nicas::nicas_randomize ( class(nicas_type), intent(in)  nicas,
type(mpl_type), intent(in)  mpl,
type(rng_type), intent(inout)  rng,
type(nam_type), intent(in), target  nam,
type(geom_type), intent(in), target  geom,
type(bpar_type), intent(in), target  bpar,
integer, intent(in)  ne,
type(ens_type), intent(out)  ens 
)
private

Definition at line 1472 of file type_nicas.F90.

◆ nicas_read()

subroutine type_nicas::nicas_read ( class(nicas_type), intent(inout)  nicas,
type(mpl_type), intent(in)  mpl,
type(nam_type), intent(in)  nam,
type(geom_type), intent(in)  geom,
type(bpar_type), intent(in)  bpar 
)
private

Definition at line 145 of file type_nicas.F90.

◆ nicas_run_nicas()

subroutine type_nicas::nicas_run_nicas ( class(nicas_type), intent(inout)  nicas,
type(mpl_type), intent(inout)  mpl,
type(rng_type), intent(inout)  rng,
type(nam_type), intent(inout)  nam,
type(geom_type), intent(inout)  geom,
type(bpar_type), intent(in)  bpar,
type(cmat_type), intent(in)  cmat 
)
private

Definition at line 478 of file type_nicas.F90.

◆ nicas_run_nicas_tests()

subroutine type_nicas::nicas_run_nicas_tests ( class(nicas_type), intent(inout)  nicas,
type(mpl_type), intent(inout)  mpl,
type(rng_type), intent(inout)  rng,
type(nam_type), intent(inout)  nam,
type(geom_type), intent(inout)  geom,
type(bpar_type), intent(in)  bpar,
type(io_type), intent(in)  io,
type(cmat_type), intent(in)  cmat,
type(ens_type), intent(in)  ens 
)
private

Definition at line 544 of file type_nicas.F90.

◆ nicas_test_adjoint()

subroutine type_nicas::nicas_test_adjoint ( class(nicas_type), intent(in)  nicas,
type(mpl_type), intent(in)  mpl,
type(rng_type), intent(inout)  rng,
type(nam_type), intent(in)  nam,
type(geom_type), intent(in)  geom,
type(bpar_type), intent(in)  bpar,
type(ens_type), intent(in)  ens 
)
private

Definition at line 1657 of file type_nicas.F90.

◆ nicas_test_consistency()

subroutine type_nicas::nicas_test_consistency ( class(nicas_type), intent(in)  nicas,
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(bpar_type), intent(in)  bpar,
type(io_type), intent(in)  io,
type(cmat_type), intent(in)  cmat 
)
private

Definition at line 2020 of file type_nicas.F90.

◆ nicas_test_dirac()

subroutine type_nicas::nicas_test_dirac ( class(nicas_type), intent(in)  nicas,
type(mpl_type), intent(inout)  mpl,
type(nam_type), intent(in)  nam,
type(geom_type), intent(in)  geom,
type(bpar_type), intent(in)  bpar,
type(io_type), intent(in)  io,
type(ens_type), intent(in)  ens 
)
private

Definition at line 1854 of file type_nicas.F90.

◆ nicas_test_optimality()

subroutine type_nicas::nicas_test_optimality ( class(nicas_type), intent(in)  nicas,
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(bpar_type), intent(in)  bpar,
type(io_type), intent(in)  io 
)
private

Definition at line 2107 of file type_nicas.F90.

Here is the call graph for this function:

◆ nicas_test_randomization()

subroutine type_nicas::nicas_test_randomization ( class(nicas_type), intent(in)  nicas,
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(bpar_type), intent(in)  bpar,
type(io_type), intent(in)  io 
)
private

Definition at line 1917 of file type_nicas.F90.

Here is the call graph for this function:

◆ nicas_test_sqrt()

subroutine type_nicas::nicas_test_sqrt ( class(nicas_type), intent(in)  nicas,
type(mpl_type), intent(inout)  mpl,
type(rng_type), intent(inout)  rng,
type(nam_type), intent(inout), target  nam,
type(geom_type), intent(in), target  geom,
type(bpar_type), intent(in)  bpar,
type(io_type), intent(in)  io,
type(cmat_type), intent(in)  cmat,
type(ens_type), intent(in)  ens 
)
private

Definition at line 1739 of file type_nicas.F90.

◆ nicas_write()

subroutine type_nicas::nicas_write ( class(nicas_type), intent(in)  nicas,
type(mpl_type), intent(in)  mpl,
type(nam_type), intent(in)  nam,
type(geom_type), intent(in)  geom,
type(bpar_type), intent(in)  bpar 
)
private

Definition at line 288 of file type_nicas.F90.

◆ nicas_write_mpi_summary()

subroutine type_nicas::nicas_write_mpi_summary ( class(nicas_type), intent(in)  nicas,
type(mpl_type), intent(in)  mpl,
type(nam_type), intent(in)  nam,
type(geom_type), intent(in)  geom,
type(bpar_type), intent(in)  bpar 
)
private

Definition at line 395 of file type_nicas.F90.

Variable Documentation

◆ ne_rand

integer, parameter type_nicas::ne_rand = 150

Definition at line 33 of file type_nicas.F90.

◆ nfac

integer, parameter type_nicas::nfac = 10

Definition at line 34 of file type_nicas.F90.

◆ ntest

integer, parameter type_nicas::ntest = 100

Definition at line 35 of file type_nicas.F90.

◆ pos_def_test

logical, parameter type_nicas::pos_def_test = .false.

Definition at line 36 of file type_nicas.F90.