MODULE sms_pisces
!!----------------------------------------------------------------------
!! *** sms_pisces.F90 ***
!! TOP : PISCES Source Minus Sink variables are declared and allocated
!!----------------------------------------------------------------------
!! History : 1.0 ! 2000-02 (O. Aumont) original code
!! 3.2 ! 2009-04 (C. Ethe & NEMO team) style
!!----------------------------------------------------------------------
USE par_oce
USE par_trc
IMPLICIT NONE
PUBLIC
CHARACTER(:), ALLOCATABLE :: numnatp_ref !! Character buffer for reference namelist pisces
CHARACTER(:), ALLOCATABLE :: numnatp_cfg !! Character buffer for configuration namelist pisces
INTEGER :: numonp = -1 !! Logical unit for namelist pisces output
!!* Model used
LOGICAL :: ln_p2z !: Flag to use LOBSTER model
LOGICAL :: ln_p4z !: Flag to use PISCES model
LOGICAL :: ln_p5z !: Flag to use PISCES quota model
LOGICAL :: ln_ligand !: Flag to enable organic ligands
LOGICAL :: ln_sediment !: Flag to enable sediment module
!!* Time variables
INTEGER :: nrdttrc !: ???
REAL(wp) :: rfact , rfactr !: time step duration (in seconds)
REAL(wp) :: rfact2, rfact2r !: time step duration (in seconds) when timesplitting is activated for PISCES
REAL(wp) :: xstep !: Time step duration for biology
REAL(wp) :: ryyss !: number of seconds per year
REAL(wp) :: r1_ryyss !: inverse number of seconds per year
!!* Biological parameters
REAL(wp) :: rno3 !: C/N stoichiometric ratio
REAL(wp) :: o2ut !: O2/N stoichiometric ratio for ammonification
REAL(wp) :: po4r !: C/P stoichiometric ratio
REAL(wp) :: rdenit !: C/N ratio for denitrification
REAL(wp) :: rdenita !: C/N ratio for denitrification
REAL(wp) :: o2nit !: O2/N ratio for nitrification
REAL(wp) :: wsbio, wsbio2 !: Sinking speeds of particles
REAL(wp) :: wsbio2max !: Maximum sinking speed of the largest particles
REAL(wp) :: wsbio2scale !: Length scale for the variations of wsbio2
REAL(wp) :: oxymin !: half saturation constant for anoxia
REAL(wp) :: xkmort !: Mortality half-saturation constant
REAL(wp) :: feratz !: Fe/C in microzooplankton
REAL(wp) :: feratm !: Fe/C in mesozooplankton
REAL(wp) :: ldocp !: Ligand production ratio during PP
REAL(wp) :: ldocz !: Ligand production ratio by grazing
REAL(wp) :: lthet !: Uptake of ligand by phytoplankton
REAL(wp) :: no3rat3 !: C/N ratio of zooplankton
REAL(wp) :: po4rat3 !: C/P ratio of zooplankton
!!* diagnostic parameters
REAL(wp) :: tpp !: total primary production
REAL(wp) :: t_oce_co2_exp !: total carbon export
REAL(wp) :: t_oce_co2_flx !: Total ocean carbon flux
REAL(wp) :: t_oce_co2_flx_cum !: Cumulative Total ocean carbon flux
REAL(wp) :: t_atm_co2_flx !: global mean of atmospheric pco2
!!* restoring
LOGICAL :: ln_pisdmp !: restoring or not of nutrients to a mean value
INTEGER :: nn_pisdmp !: frequency of relaxation or not of nutrients to a mean value
!!* Mass conservation
LOGICAL :: ln_check_mass !: Flag to check mass conservation
LOGICAL, PUBLIC :: ln_ironice !: boolean for Fe input from sea ice
!!* Diurnal cycle in PISCES
LOGICAL :: ln_p4z_dcyc !: Flag to activate diurnal cycle in PISCES
!!* Biological fluxes for light : variables shared by pisces & lobster
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,: ) :: strn !: Day duration in hours
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: enano, ediat !: PAR for phyto, nano and diat
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: enanom, ediatm !: mean PAR for phyto, nano and diat
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: epico !: PAR for pico
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: epicom !: mean PAR for pico
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: emoy, etotm !: averaged PAR in the mixed layer
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:) :: xksi !: Half-saturation con,stant for diatoms
!!* Biological fluxes for primary production
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:) :: xksimax !: Maximum half-saturation constant over the year (Si)
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: biron !: bioavailable fraction of iron
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: plig !: proportion of iron organically complexed
!!* Sinking speed
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: wsbio3 !: POC sinking speed
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: wsbio4 !: GOC sinking speed
!!* SMS for the organic matter
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: xfracal !: Fraction of nanophytoplankton that are calcifying organisms
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: nitrfac !: OMZ
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: nitrfac2 !: N depleted indice
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: orem !: oxic remineralisation
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: xdiss !: Shear rate
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: prodcal !: Calcite production
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: prodpoc !: POC production
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: conspoc !: POC consumption
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: prodgoc !: GOC production
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: consgoc !: GOC consumption
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: consfe3 !: GOC consumption
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: blim !: bacterial production factor
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: sizen !: size of nanophyto
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: sizep !: size of picophyto
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: sized !: size of diatoms
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: sizena !: size of nanophytoplankton, after
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: sizepa !: size of picophyto, after
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: sizeda !: size of diatomss, after
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: xfecolagg !: Refractory diagnostic concentration of ligands
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: xcoagfe !: Coagulation rate of colloidal Fe/ligands
!!* Variable for chemistry of the CO2 cycle
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: ak13 !: Carbonate chemistry constant
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: ak23 !: Carbonate chemistry constant
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: aksp !: Solubility product of CaCO3
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: hi !: Proton concentration
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: excess !: CO3 saturation
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: aphscale !:
!!* Temperature dependancy of SMS terms
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: tgfunc !: Temp. dependancy of various biological rates
REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: tgfunc2 !: Temp. dependancy of mesozooplankton rates
LOGICAL, SAVE :: lk_sed
!! * Substitutions
# include "do_loop_substitute.h90"
!!----------------------------------------------------------------------
!! NEMO/TOP 4.0 , NEMO Consortium (2018)
!! $Id: sms_pisces.F90 15459 2021-10-29 08:19:18Z cetlod $
!! Software governed by the CeCILL license (see ./LICENSE)
!!----------------------------------------------------------------------
CONTAINS
INTEGER FUNCTION sms_pisces_alloc()
!!----------------------------------------------------------------------
!! *** ROUTINE sms_pisces_alloc ***
!!----------------------------------------------------------------------
USE lib_mpp , ONLY: ctl_stop
INTEGER :: ierr(11) ! Local variables
!!----------------------------------------------------------------------
ierr(:) = 0
!* Biological fluxes for light : shared variables for pisces & lobster
ALLOCATE( xksi(jpi,jpj), strn(jpi,jpj), STAT=ierr(1) )
IF( ln_p4z .OR. ln_p5z ) THEN
!* Optics
ALLOCATE( enano(A2D(0),jpk) , ediat(A2D(0),jpk) , &
& enanom(A2D(0),jpk), ediatm(A2D(0),jpk), &
& emoy(A2D(0),jpk) , etotm(A2D(0),jpk), STAT=ierr(2) )
!* Biological SMS
ALLOCATE( xksimax(jpi,jpj) , biron(A2D(0),jpk) , STAT=ierr(3) )
! Biological SMS
ALLOCATE( xfracal (A2D(0),jpk), orem (A2D(0),jpk), &
& nitrfac (A2D(0),jpk), nitrfac2(A2D(0),jpk), &
& prodcal (A2D(0),jpk), xdiss (A2D(0),jpk), &
& prodpoc (A2D(0),jpk), conspoc (A2D(0),jpk), &
& prodgoc (A2D(0),jpk), consgoc (A2D(0),jpk), &
& blim (A2D(0),jpk), consfe3 (A2D(0),jpk), &
& xfecolagg(A2D(0),jpk), xcoagfe (A2D(0),jpk), STAT=ierr(4) )
!* Carbonate chemistry
ALLOCATE( ak13 (A2D(0),jpk) , &
& ak23(A2D(0),jpk) , aksp (A2D(0),jpk) , &
& hi (A2D(0),jpk) , excess(A2D(0),jpk) , &
& aphscale(A2D(0),jpk), STAT=ierr(5) )
!
!* Temperature dependency of SMS terms
ALLOCATE( tgfunc (A2D(0),jpk) , tgfunc2(A2D(0),jpk), STAT=ierr(6) )
!
!* Sinking speed
ALLOCATE( wsbio3 (A2D(0),jpk) , wsbio4 (A2D(0),jpk), STAT=ierr(7) )
!* Size of phytoplankton cells
ALLOCATE( sizen (A2D(0),jpk), sized (A2D(0),jpk), &
& sizena(A2D(0),jpk), sizeda(A2D(0),jpk), STAT=ierr(8) )
!
ALLOCATE( plig(A2D(0),jpk) , STAT=ierr(9) )
ENDIF
!
IF( ln_p5z ) THEN
! PISCES-QUOTA specific part
ALLOCATE( epico(A2D(0),jpk) , epicom(A2D(0),jpk) , STAT=ierr(10) )
!* Size of phytoplankton cells
ALLOCATE( sizep(A2D(0),jpk), sizepa(A2D(0),jpk), STAT=ierr(11) )
ENDIF
!
sms_pisces_alloc = MAXVAL( ierr )
!
IF( sms_pisces_alloc /= 0 ) CALL ctl_stop( 'STOP', 'sms_pisces_alloc: failed to allocate arrays' )
!
END FUNCTION sms_pisces_alloc
!!======================================================================
END MODULE sms_pisces