Procedures

Divide the aggregated data by a specified factor.

Initialise the aggregator by allocating the aggregated data array and its aggregation method. The values in the aggregated data array are reset according to the specified aggregation method.

Offset the aggregated data by a specified value.

Return the rank of the aggregator.

Scale the aggregated data by a specified factor.

Set the aggregation method for the aggregator by assigning the appropriate accumulation and reset procedures based on the specified method.

Return the shape of the aggregator.

Return a string identifier of the aggregator type (e.g., "int32", "real32", "real64").

Allocate phen derived type instance. Allocated arrays are initialised to zero.

set the following two backflow to set (see Bolker 199x)

Check if two integer arrays are equal.

Calculate the index corresponding to a given memory offset in a multi-dimensional array.

Calculate the memory offset corresponding to a given index in a multi-dimensional array.

Compute start and count for the p'th partition of an array of size n where p = 0, 1, ... , k - 1.

vh_js !!

Abort CABLE with an error message.

Model initialisation routine for the CABLE offline driver.

Model initialisation routine (CRU specific). TRENDY experiment using CRU-NCEP.

Model initialisation routine (default met specific).

Model initialisation routine (GSWP specific).

Model initialisation routine (PLUME specific). PLUME experiment setup using WATCH.

Model initialisation routine (site met specific). Site experiment, e.g. AmazonFace (spinup or transient run type).

Default implementation of the abort procedure for the base error handler.

Build an error message string.

Free the global error handler instance.

Implementation of the abort procedure for the MPI-aware error handler.

Set the global error handler instance.

Create a new decomposition for parallel I/O. This follows the degree of freedom approach for specifying I/O decompositions as described in Denis et al. (2011) [10.1177/1094342011428143].

Create a new netCDF file with the specified path and I/O type.

Module finalization procedure for the cable_netcdf_mod module.

Open an existing netCDF file with the specified path and I/O type.

Interfaces for procedures used by cable_output_impl.

Interfaces for procedures used by cable_output_impl.

Interfaces for procedures used by cable_output_impl.

Interfaces for procedures used by cable_output_impl.

Return the dimension name.

Return the dimension size.

Returns an output variable dimension. This function contains the definitions of all dimensions used to describe the in-memory data shapes of CABLE variables.

Interface for associating a pointer array with the the appropriate reduction buffer, taking into account the output variable shape, type and reduction method.

Interfaces for procedures used by cable_output_impl.

Interfaces for procedures used by cable_output_impl.

Custom constructor for cable_output_variable_t.

Return the netCDF variable name, which defaults to field_name if not specified via netcdf_name.

Interfaces for procedures used by cable_output_impl.

Utility function to determine whether one frequency is greater than another following the ordering "all" > "user" > "daily" > "monthly".

Determines whether the current time step matches the specified frequency.

Set the start year of the simulation. This is used for calculating monthly timing.

Computes the fraction of net photosynthate allocated to leaf, wood and froot using an allocation scheme modified from Pierre Friedlingstein.

revise turnover and NPP and dcplantdt to reflect above adjustments End of adjustments to avoid negative stores Ticket#108

vh_js!

vh_js !! vh_js !! vh_js

Carbon allocation algorithm implemented by Dan Qiu and YP Wang in 2011 based on Adam Wolf 1 and 2

CLN CHARACTER(LEN=99), INTENT(IN) :: fcnpspin vh_js !! CLN901 format(A99) WHERE (pop%pop_grid(:)%cmass_sum_old.gt.0.1 .and. pop%pop_grid(:)%cmass_sum.gt.0.1 ) casapool%Cplant(Iw,2) = casapool%Cplant(Iw,2)(1.0- min( POP%pop_grid(:)%cat_mortality/(POP%pop_grid(:)%cmass_sum_old),0.99)) casapool%Nplant(Iw,2) = casapool%Nplant(Iw,2)(1.0- min( POP%pop_grid(:)%cat_mortality/(POP%pop_grid(:)%cmass_sum_old),0.99)) ENDWHERE

Checks whether the value(s) of an output variable are within their specified range of physical values.

Calculates the extinction coefficients for black leaves. It returns:

This SUBROUTINE evaluates the value of the friction velocity $u_*$ as used during the iteration loop of the Monin-Obukhov (MO) similarity theory in define_canopy. $u_*$ is used when quantifying the stability parameter canopy%zetar in update_zetar, and when evaluating the resistance network components rt0 and rt1 in define_canopy. The friction velocity quantifies the magnitude of turbulent mixing that is occurring as well as the flux of momentum from the atmosphere to the land.

Compare reference values for quasi-bitwise reproducibility checks and write reference value on failed reproducibility.

Returns a list of coordinate variables to be included in an output stream based on the output grid type.

canopy%fes_cor = 0.0

Interface for extracting the value from the first patch/tile in each grid cell for various data types and array ranks. This is useful for arrays where averaging along the patch/tile dimension does not make sense, or where the array contains the same value everywhere along the patch/tile dimension.

Extracts the first patch value for each grid cell from a 1D integer array.

Extracts the first patch value for each grid cell from a 2D integer array.

Extracts the first patch value for each grid cell from a 3D integer array.

Extracts the first patch value for each grid cell from a 1D 32-bit real array.

Extracts the first patch value for each grid cell from a 2D 32-bit real array.

Extracts the first patch value for each grid cell from a 3D 32-bit real array.

Extracts the first patch value for each grid cell from a 1D 64-bit real array.

Extracts the first patch value for each grid cell from a 2D 64-bit real array.

Extracts the first patch value for each grid cell from a 3D 64-bit real array.

Helper subroutine to get initialise optional scale, div, and offset arguments for accumulate procedures.

Searches for CABLE parameters in the met forcing file, and if it finds any, uses these values to overwrite the values that have already been loaded from the default parameter loading and/or the restart file.

Root extraction : Haverd et al. 2013

Interface for computing the area weighted average over the patch/tile dimension for various data types and array ranks.

Computes the area weighted average over the patch/tile dimension for a 1D 32-bit real array.

Computes the area weighted average over the patch/tile dimension for a 2D 32-bit real array.

Computes the area weighted average over the patch/tile dimension for a 3D 32-bit real array.

Computes the area weighted average over the patch/tile dimension for a 1D 64-bit real array.

Computes the area weighted average over the patch/tile dimension for a 2D 64-bit real array.

Computes the area weighted average over the patch/tile dimension for a 3D 64-bit real array.

MMY : move from subroutine derived_parameters to here since derived_parameters is now an option but compulsory

This subroutine computes the height of the canopy above ground/snow surface when there is snow present.

Infers the appropriate netCDF dimensions for a given output variable based on its data shape and the grid type of the output stream.

Initialise local structure variables for the current MPI rank

Initialize the surface wetness factor of the soil/snow (ssnow_wetfac) array

Returns a parallel I/O decomposition mapping from a memory layout with a local 'land' dimension to a netCDF variable layout with a global 'land' dimension.

Returns a parallel I/O decomposition mapping from a memory layout with a 'land' dimension to a netCDF variable layout with 'x' and 'y' dimensions.

Returns a parallel I/O decomposition mapping from a memory layout with a 'patch' dimension to a netCDF variable layout with a 'land' and 'patch' dimension.

Returns a parallel I/O decomposition mapping from a memory layout with a local 'patch' dimension to a netCDF variable layout with a global 'patch' dimension.

Returns a parallel I/O decomposition mapping from a memory layout with a 'patch' dimension to a netCDF variable layout with 'x', 'y', and 'patch' dimensions.

This subroutine computes the leaf-area index of a canopy when there is snow present. The formulae assume that the leaf area is distributed uniformly in the vertical within the canopy.

Allocates the luc%%var(imland,mvmax) variables

Allocates the luc%var(mp) variables.

Checks the mass balance and writes the output CNP pool sizes for each plant functional type.

Deallocates the luc%var(mland,mvmax) variables

Deallocates the luc%var(mp) variables

Main driver for the land-use change

Maps luc%var_y(mland,mvmax) to lucmp%var(mp)

Assigns lucmp%var(mp) to luc%var_x(mland,mvmax)

Redistribution of the plant functional type transition to ensure that the change in plant functional type fractions from the state data is consistent with the estimates from previous states and transition.

This subroutine applies the land-use changes to the transfer of the C, N and P pools, the biophysical states, the soil texture and the soil order for each patch. Then it will seed the deforested land.

Assigns luc%var_y to luc%var_x

This SUBROUTINE converts the previously evaluated rate of potential evaporation ssnow_potev from the soil into the associated latent heat flux canopy_fes. The evaluation accounts for whether the water flux is in liquid or solid phase (evaporation or sublimation, dew or frost), the direction of the flux (to or from the soil), and any limits due to a lack of water in the surface layer of the soil column. The SUBROUTINE also evaluates the partition of the latent heat flux between soil canopy_fess and puddle canopy_fesp contributions.

Defines the priority order of sources of parameter values for CABLE, determines the total number of patches over all grid cells, and writes parameter values to CABLE's parameter arrays.

Reading LU input data, zeroing biomass in empty secondary forest tiles and tranferring LUC-based age weights for secondary forest to POP structure

Calculates the energy and water balances at each time step as well as the cumulative balance over the simulation.

Accumulate the aggregated data from the source data using the max aggregation method.

Reset the aggregated data for the max aggregation method.

Accumulate the aggregated data from the source data using the mean aggregation method.

Accumulate the aggregated data from the source data using the min aggregation method.

Reset the aggregated data for the min aggregation method.

Check if an MPI return code signaled an error. If so, print the corresponding message and abort the execution.

Class method to abort execution of an MPI group.

Class method to check if the communicator is defined.

Contructor for mpi_grp_t class.

Contructor for mpi_grp_t using the legacy communicator type.

Class method to split an MPI group.

Overload the default construct for mpi_grp_t

Finalise MPI.

Initialise MPI and set default communicator.

Stub for when MPI is not available

Stub for when MPI is not available

Returns the netCDF dimension(s) corresponding to a given output variable dimension, taking into account the output grid type and reduction method. This function is used to determine the dimensions of netCDF variables based on the in-memory data shapes of CABLE variables as described by cable_output_dim_t instances.

Infers the appropriate netCDF variable type for a given output variable.

Factory interface for creating new aggregator instances. The specific type of aggregator created is determined by the type of the source data array provided.

Create a new 0D integer aggregator.

Create a new 1D integer aggregator.

Create a new 2D integer aggregator.

Create a new 3D integer aggregator.

Create a new 0D 32-bit real aggregator.

Create a new 1D 32-bit real aggregator.

Create a new 2D 32-bit real aggregator.

Create a new 3D 32-bit real aggregator.

Create a new 0D 64-bit real aggregator.

Create a new 1D 64-bit real aggregator.

Create a new 2D 64-bit real aggregator.

Create a new 3D 64-bit real aggregator.

Reset the aggregated data for aggregation methods other than point, min, and max.

Returns the land index corresponding to the given patch index, using cstart and nap to determine the mapping. If the patch index does not lie on any land point, the function aborts.

Accumulate the aggregated data from the source data using the point aggregation method.

Reset the aggregated data for the point aggregation method. This is a no-op since point aggregation always takes the value of the most recent data point.

Select the correct files given the year for filenames following the gswp format

Select the correct files given the year for filenames following the princeton format

Evaluates the integrated similarity function for momentum transfer, $\psi_m(\xi)$.

Evaluates the integrated similarity function for turbulent transfer of scalars, $\psi_s(\xi)$.

This SUBROUTINE evaluates the specific humidity (water vapour mixing ratio) at saturation (in kgkg$^{-1}$), at a given air temperature (in $^{\circ}$C) and air pressure (in hPa) for an array of size mp.

This SUBROUTINE evaluates the specific humidity (water vapour mixing ratio) at saturation (in kgkg$^{-1}$), at a given air temperature (in $^{\circ}$C) and air pressure (in hPa).

Removes transpiration water from soil. We also attribute the negative canopy transpiration (dew) to the wet canopy flux.

Replace the year in the filename with the value of ncciy for the gswp file format.

Replace the year in the filename with the value of ncciy for the princeton format

Calculates the roughness parameters and the aerodynamic contribution to the resistances controlling the fluxes between the land and atmosphere for each land point.

Offline serial driver.

Sets the global attributes for a given output stream.

calculate snow processes and thermal soil

CLN CHARACTER(LEN=99), INTENT(IN) :: fcnpspin vh_js !! CLN OPEN(91, file=fcnpspin) CLN read(91,*) myearspin CLN901 format(A99) WHERE(xkNlimiting .eq. 0) !Chris Lu 4/June/2012 xkNlimiting = 0.001 END WHERE call totcnppools(1,veg,casamet,casapool,bmcplant,bmnplant,bmpplant,bmclitter,bmnlitter,bmplitter, & bmcsoil,bmnsoil,bmpsoil,bmnsoilmin,bmpsoillab,bmpsoilsorb,bmpsoilocc,bmarea)

Accumulate the aggregated data from the source data using the sum aggregation method.

Translate local land index on current MPI rank to global land index

Calculates the amount of water removed from the soil by transpiration.

This SUBROUTINE updates the value of the stability parameter $\xi$ during the iteration loop of the Monin-Obukhov (MO) similarity theory in define_canopy.
$\xi$ quantifies the role that the surface fluxes play in setting the efficiency of turbulent transfer from the land to the atmosphere, and hence the aerodynamic component of the resistance network for those same surface fluxes (an implicit problem which requires iteration to solve).