Options for calculating Bayesian cost function. More...
#include <CloudCostFunction.h>
Public Attributes | |
| oops::RequiredParameter< std::string > | chanlist {"cost channels list", this} |
| Set of channels used in the calculation of the cost function. More... | |
| oops::RequiredParameter< std::string > | rmatrix_filepath {"RMatrix", this} |
| Path to location of file describing the R-matrix. More... | |
| oops::RequiredParameter< std::string > | bmatrix_filepath {"BMatrix", this} |
| Path to location of file describing the B-matrix. More... | |
| oops::RequiredParameter< std::vector< std::string > > | field_names {"background fields", this} |
| List of geovals describing fields required from the B-matrix. More... | |
| oops::Parameter< bool > | qtotal_lnq_gkg {"qtotal", false, this} |
| B-matrix file contains error covariances for ln(qtotal in units g/kg) More... | |
| oops::Parameter< bool > | qtotal_split_rain {"qtotal split rain", false, this} |
| Include treatment of rain when splitting total humidity into constituent phases. More... | |
| oops::Parameter< bool > | scattering_switch {"scattering radiative transfer", false, this} |
| Include gradient due to ice in brightness temperature total humidity Jacobian. More... | |
| oops::Parameter< float > | min_q {"minimum specific humidity", 3.0e-6f, this} |
| Limit specific humidity to minimum value. More... | |
| oops::Parameter< bool > | reverse_Jacobian {"reverse Jacobian order", false, this} |
| Jacobian vertical ordering is reverse of geovals. More... | |
| oops::Parameter< float > | minTb {"minimum ObsValue", 70.0, this} |
| Minimum bound for ObsValue brightness temperature. More... | |
| oops::Parameter< float > | maxTb {"maximum ObsValue", 340.0, this} |
| Maximum bound for ObsValue brightness temperature. More... | |
| oops::Parameter< float > | maxCost {"maximum final cost", 1600.0, this} |
| Maximum value for final cost returned by the ObsFunction. More... | |
| oops::Parameter< std::string > | HofXGroup {"HofX group", "HofX", this} |
| Name of the H(x) group used in the cost function calculation. More... | |
Detailed Description
Options for calculating Bayesian cost function.
Definition at line 29 of file CloudCostFunction.h.
Member Data Documentation
◆ bmatrix_filepath
| oops::RequiredParameter<std::string> ufo::CloudCostFunctionParameters::bmatrix_filepath {"BMatrix", this} |
Path to location of file describing the B-matrix.
Definition at line 40 of file CloudCostFunction.h.
◆ chanlist
| oops::RequiredParameter<std::string> ufo::CloudCostFunctionParameters::chanlist {"cost channels list", this} |
Set of channels used in the calculation of the cost function.
Definition at line 34 of file CloudCostFunction.h.
◆ field_names
| oops::RequiredParameter<std::vector<std::string> > ufo::CloudCostFunctionParameters::field_names {"background fields", this} |
List of geovals describing fields required from the B-matrix.
Definition at line 44 of file CloudCostFunction.h.
◆ HofXGroup
| oops::Parameter<std::string> ufo::CloudCostFunctionParameters::HofXGroup {"HofX group", "HofX", this} |
Name of the H(x) group used in the cost function calculation.
H(x) is assumed to be already bias corrected, the default is "HofX"
Example: use
HofX group: MetOfficeBiasCorrHofX
Definition at line 83 of file CloudCostFunction.h.
◆ maxCost
| oops::Parameter<float> ufo::CloudCostFunctionParameters::maxCost {"maximum final cost", 1600.0, this} |
Maximum value for final cost returned by the ObsFunction.
Definition at line 74 of file CloudCostFunction.h.
◆ maxTb
| oops::Parameter<float> ufo::CloudCostFunctionParameters::maxTb {"maximum ObsValue", 340.0, this} |
Maximum bound for ObsValue brightness temperature.
Definition at line 71 of file CloudCostFunction.h.
◆ min_q
| oops::Parameter<float> ufo::CloudCostFunctionParameters::min_q {"minimum specific humidity", 3.0e-6f, this} |
Limit specific humidity to minimum value.
Definition at line 62 of file CloudCostFunction.h.
◆ minTb
| oops::Parameter<float> ufo::CloudCostFunctionParameters::minTb {"minimum ObsValue", 70.0, this} |
Minimum bound for ObsValue brightness temperature.
Definition at line 68 of file CloudCostFunction.h.
◆ qtotal_lnq_gkg
| oops::Parameter<bool> ufo::CloudCostFunctionParameters::qtotal_lnq_gkg {"qtotal", false, this} |
B-matrix file contains error covariances for ln(qtotal in units g/kg)
Setting this flag for qtotal requires that the following are all present in the parameter list "background fields":
- specific_humidity
- mass_content_of_cloud_liquid_water_in_atmosphere_layer
- mass_content_of_cloud_ice_in_atmosphere_layer
Definition at line 53 of file CloudCostFunction.h.
◆ qtotal_split_rain
| oops::Parameter<bool> ufo::CloudCostFunctionParameters::qtotal_split_rain {"qtotal split rain", false, this} |
Include treatment of rain when splitting total humidity into constituent phases.
Definition at line 56 of file CloudCostFunction.h.
◆ reverse_Jacobian
| oops::Parameter<bool> ufo::CloudCostFunctionParameters::reverse_Jacobian {"reverse Jacobian order", false, this} |
Jacobian vertical ordering is reverse of geovals.
Definition at line 65 of file CloudCostFunction.h.
◆ rmatrix_filepath
| oops::RequiredParameter<std::string> ufo::CloudCostFunctionParameters::rmatrix_filepath {"RMatrix", this} |
Path to location of file describing the R-matrix.
Definition at line 37 of file CloudCostFunction.h.
◆ scattering_switch
| oops::Parameter<bool> ufo::CloudCostFunctionParameters::scattering_switch {"scattering radiative transfer", false, this} |
Include gradient due to ice in brightness temperature total humidity Jacobian.
Definition at line 59 of file CloudCostFunction.h.
The documentation for this class was generated from the following file:
