Difference between revisions of "sediment.in"
From WikiROMS
Jump to navigationJump to search| Line 6: | Line 6: | ||
{{note}} '''Notice:''' Detailed information about ROMS input script file syntax can be found [[Input Parameter Files|here]]. | {{note}} '''Notice:''' Detailed information about ROMS input script file syntax can be found [[Input Parameter Files|here]]. | ||
{{note}} '''Notice:''' A default <span class="red">sediment.in</span> input script is provided in the '''User/External''' subdirectory. Also there are several sediment input scripts in the '''ROMS/External''' subdirectory which are used in the distributed [[Test Cases|test cases]]. They are usually named <span class="red">sediment_</span><span class="blue">app</span><span class="red">.in</span> where <span class="blue">app</span> is the lowercase of the test case [[ | {{note}} '''Notice:''' A default <span class="red">sediment.in</span> input script is provided in the '''User/External''' subdirectory. Also there are several sediment input scripts in the '''ROMS/External''' subdirectory which are used in the distributed [[Test Cases|test cases]]. They are usually named <span class="red">sediment_</span><span class="blue">app</span><span class="red">.in</span> where <span class="blue">app</span> is the lowercase of the test case [[C Preprocessor|CPP option]]. | ||
==Sediment model control switches== | ==Sediment model control switches== | ||
* Switch is used to control sediment model computation within nested and/or multiple connected grids, [1:[[Ngrids]]] values are expected.<div class="box"> [[Lsediment]] == T</div> | * Switch is used to control sediment model computation within nested and/or multiple connected grids, [1:[[Variables#Ngrids|Ngrids]]] values are expected.<div class="box"> [[Variables#Lsediment|Lsediment]] == T</div> | ||
==General sediment bed model controls== | ==General sediment bed model controls== | ||
* Depositional bed layer thickness (m) criteria to create a new layer. If deposition exceeds this value, then a new layer is created, [1:[[Ngrids]]] values are expected.<div class="box">[[newlayer_thick|NEWLAYER_THICK]] == 0.01d0</div> | * Depositional bed layer thickness (m) criteria to create a new layer. If deposition exceeds this value, then a new layer is created, [1:[[Variables#Ngrids|Ngrids]]] values are expected.<div class="box">[[Variables#newlayer_thick|NEWLAYER_THICK]] == 0.01d0</div> | ||
* Bed load transport rate coefficient, [1:[[Ngrids]]] values are expected.<div class="box"> [[bedload_coeff|BEDLOAD_COEFF]] == 0.05d0</div> | * Bed load transport rate coefficient, [1:[[Variables#Ngrids|Ngrids]]] values are expected.<div class="box"> [[Variables#bedload_coeff|BEDLOAD_COEFF]] == 0.05d0</div> | ||
==Suspended Cohesive Sediment Parameters== | ==Suspended Cohesive Sediment Parameters== | ||
There are [[NCS]] cohesive (mud) sediment tracers per nested grid in ROMS. Therefore, [1:[[NCS]],1:[[Ngrids]]] values are expected for these parameters. | There are [[Variables#NCS|NCS]] cohesive (mud) sediment tracers per nested grid in ROMS. Therefore, [1:[[Variables#NCS|NCS]],1:[[Variables#Ngrids|Ngrids]]] values are expected for these parameters. | ||
* Median sediment grain diameter (mm).<div class="box"> [[sd50|MUD_SD50]] == 0.01d0 0.06d0 0.10d0</div> | * Median sediment grain diameter (mm).<div class="box"> [[Variables#sd50|MUD_SD50]] == 0.01d0 0.06d0 0.10d0</div> | ||
* Sediment concentration (kg/m<sup>3</sup>).<div class="box"> [[Csed|MUD_CSED]] == 0.0d0 0.0d0 0.0d0</div> | * Sediment concentration (kg/m<sup>3</sup>).<div class="box"> [[Variables#Csed|MUD_CSED]] == 0.0d0 0.0d0 0.0d0</div> | ||
* Sediment grain density (kg/m<sup>3</sup>).<div class="box"> [[Srho|MUD_SRHO]] == 2650.0d0 2650.0d0 2650.0d0</div> | * Sediment grain density (kg/m<sup>3</sup>).<div class="box"> [[Variables#Srho|MUD_SRHO]] == 2650.0d0 2650.0d0 2650.0d0</div> | ||
* Particle settling velocity (mm/s).<div class="box"> [[Wsed|MUD_WSED]] == 0.1d0 1.0d0 2.0d0</div> | * Particle settling velocity (mm/s).<div class="box"> [[Variables#Wsed|MUD_WSED]] == 0.1d0 1.0d0 2.0d0</div> | ||
* Surface erosion rate (kg/m<sup>2</sup>/s).<div class="box"> [[Erate|MUD_ERATE]] == 5.0d-5 5.0d-5 5.0d-5</div> | * Surface erosion rate (kg/m<sup>2</sup>/s).<div class="box"> [[Variables#Erate|MUD_ERATE]] == 5.0d-5 5.0d-5 5.0d-5</div> | ||
* Critical shear for erosion (N/m<sup>2</sup>).<div class="box"> [[tau_ce|MUD_TAU_CE]] == 0.05d0 0.05d0 0.05d0</div> | * Critical shear for erosion (N/m<sup>2</sup>).<div class="box"> [[Variables#tau_ce|MUD_TAU_CE]] == 0.05d0 0.05d0 0.05d0</div> | ||
* Critical stress for deposition (N/m<sup>2</sup>), not used.<div class="box"> [[tau_cd|MUD_TAU_CD]] == 0.01d0 0.01d0 0.01d0</div> | * Critical stress for deposition (N/m<sup>2</sup>), not used.<div class="box"> [[Variables#tau_cd|MUD_TAU_CD]] == 0.01d0 0.01d0 0.01d0</div> | ||
* Porosity (nondimensional): <span class="red">Vwater/(Vwater+Vsed)</span>. Its values range between '''0''' and '''1'''.<div class="box"> [[poros|MUD_POROS]] == 0.0d0 0.0d0 0.0d0</div> | * Porosity (nondimensional): <span class="red">Vwater/(Vwater+Vsed)</span>. Its values range between '''0''' and '''1'''.<div class="box"> [[Variables#poros|MUD_POROS]] == 0.0d0 0.0d0 0.0d0</div> | ||
* Lateral, harmonic and biharmonic, constant, diffusion coefficient.<div class="box"> [[tnu2|MUD_TNU2]] == 0.0d0 0.0d0 0.0d0 ! m<sup>2</sup>/s<br /> [[tnu4|MUD_TNU4]] == 0.0d0 0.0d0 0.0d0 ! m<sup>4</sup>/s</div> | * Lateral, harmonic and biharmonic, constant, diffusion coefficient.<div class="box"> [[Variables#tnu2|MUD_TNU2]] == 0.0d0 0.0d0 0.0d0 ! m<sup>2</sup>/s<br /> [[Variables#tnu4|MUD_TNU4]] == 0.0d0 0.0d0 0.0d0 ! m<sup>4</sup>/s</div> | ||
* Vertical diffusion coefficients.<div class="box"> [[Akt_bak|MUD_AKT_BAK]] == 5.0d-6 5.0d-6 5.0d-6 ! m<sup>2</sup>/s</div> | * Vertical diffusion coefficients.<div class="box"> [[Variables#Akt_bak|MUD_AKT_BAK]] == 5.0d-6 5.0d-6 5.0d-6 ! m<sup>2</sup>/s</div> | ||
* Nudging/relaxation time scales, inverse scales will be computed internally.<div class="box"> [[Tnudg|MUD_TNUDG]] == 0.0d0 0.0d0 0.0d0 ! days</div> | * Nudging/relaxation time scales, inverse scales will be computed internally.<div class="box"> [[Variables#Tnudg|MUD_TNUDG]] == 0.0d0 0.0d0 0.0d0 ! days</div> | ||
* Morphological time scale factor (greater than or equal to 1.0). A value of 1.0 has no scale effect.<div class="box"> [[morph_fac|MUD_MORPH_FAC]] == 1.0d0 1.0d0 1.0d0 ! nondimensional</div> | * Morphological time scale factor (greater than or equal to 1.0). A value of 1.0 has no scale effect.<div class="box"> [[Variables#morph_fac|MUD_MORPH_FAC]] == 1.0d0 1.0d0 1.0d0 ! nondimensional</div> | ||
* Logical switch ('''TRUE'''/'''FALSE''') to activate writing of cohesive sediment into output NetCDF file(s).<div class="box"> [[Hout|Hout(idmud)]] == T ! suspended concentration<br /> [[Hout|Hout(iMfrac)]] == T ! bed layer fraction<br /> [[Hout|Hout(iMmass)]] == T ! bed layer mass<br /> [[Hout|Hout(iMUbld)]] == T ! bed load at U-points<br /> [[Hout|Hout(iMVbld)]] == T ! bed load at V-points</div> | * Logical switch ('''TRUE'''/'''FALSE''') to activate writing of cohesive sediment into output NetCDF file(s).<div class="box"> [[Hout|Hout(idmud)]] == T ! suspended concentration<br /> [[Hout|Hout(iMfrac)]] == T ! bed layer fraction<br /> [[Hout|Hout(iMmass)]] == T ! bed layer mass<br /> [[Hout|Hout(iMUbld)]] == T ! bed load at U-points<br /> [[Hout|Hout(iMVbld)]] == T ! bed load at V-points</div> | ||
| Line 51: | Line 51: | ||
==Non-cohesive Sediment Parameters== | ==Non-cohesive Sediment Parameters== | ||
There are [[NNS]] non-cohesive (sand) sediment tracers per nested grid in ROMS. Therefore, [1:[[NNS]],1:[[Ngrids]]] values are expected for these parameters. | There are [[Variables#NNS|NNS]] non-cohesive (sand) sediment tracers per nested grid in ROMS. Therefore, [1:[[Variables#NNS|NNS]],1:[[Variables#Ngrids|Ngrids]]] values are expected for these parameters. | ||
* Median sediment grain diameter (mm).<div class="box"> [[sd50|SAND_SD50]] == 1.0d0</div> | * Median sediment grain diameter (mm).<div class="box"> [[Variables#sd50|SAND_SD50]] == 1.0d0</div> | ||
* Sediment concentration (kg/m<sup>3</sup>).<div class="box"> [[Csed|SAND_CSED]] == 0.0d0</div> | * Sediment concentration (kg/m<sup>3</sup>).<div class="box"> [[Variables#Csed|SAND_CSED]] == 0.0d0</div> | ||
* Sediment grain density (kg/m<sup>3</sup>).<div class="box"> [[Srho|SAND_SRHO]] == 2650.0d0</div> | * Sediment grain density (kg/m<sup>3</sup>).<div class="box"> [[Variables#Srho|SAND_SRHO]] == 2650.0d0</div> | ||
* Particle settling velocity (mm/s).<div class="box"> [[Wsed|SAND_WSED]] == 1.0d0</div> | * Particle settling velocity (mm/s).<div class="box"> [[Variables#Wsed|SAND_WSED]] == 1.0d0</div> | ||
* Surface erosion rate (kg/m<sup>2</sup>/s).<div class="box"> [[Erate|SAND_ERATE]] == 1.0d-5</div> | * Surface erosion rate (kg/m<sup>2</sup>/s).<div class="box"> [[Variables#Erate|SAND_ERATE]] == 1.0d-5</div> | ||
* Critical shear for erosion and deposition (N/m<sup>2</sup>).<div class="box"> [[tau_ce|SAND_TAU_CE]] == 0.07d0<br /> [[tau_cd|SAND_TAU_CD]] == 0.02d0</div> | * Critical shear for erosion and deposition (N/m<sup>2</sup>).<div class="box"> [[Variables#tau_ce|SAND_TAU_CE]] == 0.07d0<br /> [[Variables#tau_cd|SAND_TAU_CD]] == 0.02d0</div> | ||
* Porosity (nondimensional): <span class="red">Vwater/(Vwater+Vsed)</span>. Its values range between '''0''' and '''1'''.<div class="box"> [[poros|SAND_POROS]] == 0.5d0</div> | * Porosity (nondimensional): <span class="red">Vwater/(Vwater+Vsed)</span>. Its values range between '''0''' and '''1'''.<div class="box"> [[Variables#poros|SAND_POROS]] == 0.5d0</div> | ||
* Lateral, harmonic and biharmonic, constant | * Lateral, harmonic and biharmonic, constant diffusion coefficient.<div class="box"> [[Variables#tnu2|SAND_TNU2]] == 0.0d0 ! m<sup>2</sup>/s<br /> [[Variables#tnu4|SAND_TNU4]] == 0.0d0 ! m<sup>4</sup>/s</div> | ||
* Vertical diffusion coefficients.<div class="box"> [[Akt_bak|SAND_AKT_BAK]] == 5.0d-6 ! m<sup>2</sup>/s</div> | * Vertical diffusion coefficients.<div class="box"> [[Variables#Akt_bak|SAND_AKT_BAK]] == 5.0d-6 ! m<sup>2</sup>/s</div> | ||
* Nudging/relaxation time scales, inverse scales will be computed internally.<div class="box"> [[Tnudg|SAND_TNUDG]] == 0.0d0 ! days</div> | * Nudging/relaxation time scales, inverse scales will be computed internally.<div class="box"> [[Variables#Tnudg|SAND_TNUDG]] == 0.0d0 ! days</div> | ||
* Morphological time scale factor (greater than or equal to 1.0). A value of 1.0 has no scale effect.<div class="box">[[morph_fac|SAND_MORPH_FAC]] == 1.0d0 ! nondimensional</div> | * Morphological time scale factor (greater than or equal to 1.0). A value of 1.0 has no scale effect.<div class="box">[[Variables#morph_fac|SAND_MORPH_FAC]] == 1.0d0 ! nondimensional</div> | ||
* Logical switches ('''TRUE'''/'''FALSE''') to activate writing of non-cohesive sediment fields into output NetCDF file(s).<div class="box"> [[Hout|Hout(isand)]] == T ! suspended concentration<br /> [[Hout|Hout(iSfrac)]] == T ! bed layer fraction<br /> [[Hout|Hout(iSmass)]] == T ! bed layer mass<br /> [[Hout|Hout(iSUbld)]] == T ! bed load at U-points<br /> [[Hout|Hout(iSVbld)]] == T ! bed load at V-points</div> | * Logical switches ('''TRUE'''/'''FALSE''') to activate writing of non-cohesive sediment fields into output NetCDF file(s).<div class="box"> [[Hout|Hout(isand)]] == T ! suspended concentration<br /> [[Hout|Hout(iSfrac)]] == T ! bed layer fraction<br /> [[Hout|Hout(iSmass)]] == T ! bed layer mass<br /> [[Hout|Hout(iSUbld)]] == T ! bed load at U-points<br /> [[Hout|Hout(iSVbld)]] == T ! bed load at V-points</div> | ||
| Line 79: | Line 79: | ||
==Bed layer and bottom sediment parameters== | ==Bed layer and bottom sediment parameters== | ||
* Logical switches ('''TRUE'''/'''FALSE''') to activate writing of bed layer and bottom sediment fields into output NetCDF file(s), [1:[[Ngrids]]] values are expected.<div class="box"> [[Hout|Hout(ithck)]] == T ! sediment layer thickness<br /> [[Hout|Hout(iaged)]] == T ! sediment layer age<br /> [[Hout|Hout(iporo)]] == T ! sediment layer porosity<br /> [[Hout|Hout(idiff)]] == F ! biodiffusivity</div> | * Logical switches ('''TRUE'''/'''FALSE''') to activate writing of bed layer and bottom sediment fields into output NetCDF file(s), [1:[[Variables#Ngrids|Ngrids]]] values are expected.<div class="box"> [[Hout|Hout(ithck)]] == T ! sediment layer thickness<br /> [[Hout|Hout(iaged)]] == T ! sediment layer age<br /> [[Hout|Hout(iporo)]] == T ! sediment layer porosity<br /> [[Hout|Hout(idiff)]] == F ! biodiffusivity</div> | ||
Revision as of 19:33, 16 April 2008
Sediment Model Input Script - sediment.in
The sediment.in file sets the parameters for sediment output. The name of this file is set by the SPARNAM keyword in the ocean.in file. This standard input ASCII file is organized in several sections as shown below, with links to more detailed explanation where required.
Notice: Detailed information about ROMS input script file syntax can be found here.
Notice: A default sediment.in input script is provided in the User/External subdirectory. Also there are several sediment input scripts in the ROMS/External subdirectory which are used in the distributed test cases. They are usually named sediment_app.in where app is the lowercase of the test case CPP option.
Sediment model control switches
- Switch is used to control sediment model computation within nested and/or multiple connected grids, [1:Ngrids] values are expected.Lsediment == T
General sediment bed model controls
- Depositional bed layer thickness (m) criteria to create a new layer. If deposition exceeds this value, then a new layer is created, [1:Ngrids] values are expected.NEWLAYER_THICK == 0.01d0
- Bed load transport rate coefficient, [1:Ngrids] values are expected.BEDLOAD_COEFF == 0.05d0
Suspended Cohesive Sediment Parameters
There are NCS cohesive (mud) sediment tracers per nested grid in ROMS. Therefore, [1:NCS,1:Ngrids] values are expected for these parameters.
- Median sediment grain diameter (mm).MUD_SD50 == 0.01d0 0.06d0 0.10d0
- Sediment concentration (kg/m3).MUD_CSED == 0.0d0 0.0d0 0.0d0
- Sediment grain density (kg/m3).MUD_SRHO == 2650.0d0 2650.0d0 2650.0d0
- Particle settling velocity (mm/s).MUD_WSED == 0.1d0 1.0d0 2.0d0
- Surface erosion rate (kg/m2/s).MUD_ERATE == 5.0d-5 5.0d-5 5.0d-5
- Critical shear for erosion (N/m2).MUD_TAU_CE == 0.05d0 0.05d0 0.05d0
- Critical stress for deposition (N/m2), not used.MUD_TAU_CD == 0.01d0 0.01d0 0.01d0
- Porosity (nondimensional): Vwater/(Vwater+Vsed). Its values range between 0 and 1.MUD_POROS == 0.0d0 0.0d0 0.0d0
- Lateral, harmonic and biharmonic, constant, diffusion coefficient.
- Vertical diffusion coefficients.MUD_AKT_BAK == 5.0d-6 5.0d-6 5.0d-6 ! m2/s
- Nudging/relaxation time scales, inverse scales will be computed internally.MUD_TNUDG == 0.0d0 0.0d0 0.0d0 ! days
- Morphological time scale factor (greater than or equal to 1.0). A value of 1.0 has no scale effect.MUD_MORPH_FAC == 1.0d0 1.0d0 1.0d0 ! nondimensional
- Logical switch (TRUE/FALSE) to activate writing of cohesive sediment into output NetCDF file(s).Hout(idmud) == T ! suspended concentration
Hout(iMfrac) == T ! bed layer fraction
Hout(iMmass) == T ! bed layer mass
Hout(iMUbld) == T ! bed load at U-points
Hout(iMVbld) == T ! bed load at V-points
Non-cohesive Sediment Parameters
There are NNS non-cohesive (sand) sediment tracers per nested grid in ROMS. Therefore, [1:NNS,1:Ngrids] values are expected for these parameters.
- Median sediment grain diameter (mm).SAND_SD50 == 1.0d0
- Sediment concentration (kg/m3).SAND_CSED == 0.0d0
- Sediment grain density (kg/m3).SAND_SRHO == 2650.0d0
- Particle settling velocity (mm/s).SAND_WSED == 1.0d0
- Surface erosion rate (kg/m2/s).SAND_ERATE == 1.0d-5
- Critical shear for erosion and deposition (N/m2).
- Porosity (nondimensional): Vwater/(Vwater+Vsed). Its values range between 0 and 1.SAND_POROS == 0.5d0
- Lateral, harmonic and biharmonic, constant diffusion coefficient.
- Vertical diffusion coefficients.SAND_AKT_BAK == 5.0d-6 ! m2/s
- Nudging/relaxation time scales, inverse scales will be computed internally.SAND_TNUDG == 0.0d0 ! days
- Morphological time scale factor (greater than or equal to 1.0). A value of 1.0 has no scale effect.SAND_MORPH_FAC == 1.0d0 ! nondimensional
- Logical switches (TRUE/FALSE) to activate writing of non-cohesive sediment fields into output NetCDF file(s).Hout(isand) == T ! suspended concentration
Hout(iSfrac) == T ! bed layer fraction
Hout(iSmass) == T ! bed layer mass
Hout(iSUbld) == T ! bed load at U-points
Hout(iSVbld) == T ! bed load at V-points
Bed layer and bottom sediment parameters
- Logical switches (TRUE/FALSE) to activate writing of bed layer and bottom sediment fields into output NetCDF file(s), [1:Ngrids] values are expected.Hout(ithck) == T ! sediment layer thickness
Hout(iaged) == T ! sediment layer age
Hout(iporo) == T ! sediment layer porosity
Hout(idiff) == F ! biodiffusivity
