rave/compositeenginefunctions_8h_source.html

/* --------------------------------------------------------------------

Copyright (C) 2025 Swedish Meteorological and Hydrological Institute, SMHI,


This file is part of RAVE.


RAVE is free software: you can redistribute it and/or modify

it under the terms of the GNU Lesser General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.


RAVE is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU Lesser General Public License for more details.


You should have received a copy of the GNU Lesser General Public License

along with RAVE.  If not, see <http://www.gnu.org/licenses/>.

------------------------------------------------------------------------*/

 #ifndef COMPOSITE_ENGINE_FUNCTIONS_H

 #define COMPOSITE_ENGINE_FUNCTIONS_H

 #include "cartesian.h"

 #include "cartesianvolume.h"

 #include "compositearguments.h"

 #include "compositeengine.h"

 #include "rave_object.h"

 #include "rave_types.h"

 #include "rave_value.h"

 #include <strings.h>


#define DEFAULT_ZR_A 200.0


 #define DEFAULT_ZR_B 1.6


int CompositeEngineFunctions_prepareRATE(CompositeEngine_t* engine, CompositeArguments_t* arguments, CompositeEngineObjectBinding_t* bindings, int nbindings);


int CompositeEngineFunctions_updateRATECoefficients(CompositeArguments_t* arguments, Cartesian_t* cartesian, CompositeEngineObjectBinding_t* bindings, int nbindings);


double CompositeEngineFunction_convertDbzToRate(CompositeEngineObjectBinding_t* binding, RaveValueType valuetype, double value, double default_zr_a, double default_zr_b);


int CompositeEngineFunctions_getRATEValueAtPosition(CompositeEngine_t* engine, void* extradata, CompositeArguments_t* arguments, CompositeEngineObjectBinding_t* binding, const char* quantity, PolarNavigationInfo* navinfo, const char* qiFieldName, RaveValueType* otype, double* ovalue, double* qivalue);


 #endif /* COMPOSITE_ENGINE_BASE_H */


cartesian.h
Defines the functions available when working with cartesian products.

Cartesian_t
struct _Cartesian_t Cartesian_t
Defines a Cartesian product.
Definition cartesian.h:43

cartesianvolume.h
Defines the functions available when working with cartesian volumes.

compositearguments.h
The arguments that should be passed on to the composite generator.

CompositeArguments_t
struct _CompositeArguments_t CompositeArguments_t
Defines a Geographical Area.
Definition compositearguments.h:41

compositeengine.h
Provides base functionality for creating composites.

CompositeEngine_t
struct _CompositeEngine_t CompositeEngine_t
Defines a Composite engine.
Definition compositeengine.h:41

CompositeEngineFunctions_getRATEValueAtPosition
int CompositeEngineFunctions_getRATEValueAtPosition(CompositeEngine_t *engine, void *extradata, CompositeArguments_t *arguments, CompositeEngineObjectBinding_t *binding, const char *quantity, PolarNavigationInfo *navinfo, const char *qiFieldName, RaveValueType *otype, double *ovalue, double *qivalue)
Gets the DBZH (quantity) value at the position and converts it to rain rate if possible which is retu...
Definition compositeenginefunctions.c:238

CompositeEngineFunctions_updateRATECoefficients
int CompositeEngineFunctions_updateRATECoefficients(CompositeArguments_t *arguments, Cartesian_t *cartesian, CompositeEngineObjectBinding_t *bindings, int nbindings)
Updates the how/product_parameters - group for the cartesian parameter "RATE" if found.
Definition compositeenginefunctions.c:116

CompositeEngineFunction_convertDbzToRate
double CompositeEngineFunction_convertDbzToRate(CompositeEngineObjectBinding_t *binding, RaveValueType valuetype, double value, double default_zr_a, double default_zr_b)
Each binding has got a member called value which is of type RaveValue_t.
Definition compositeenginefunctions.c:216

CompositeEngineFunctions_prepareRATE
int CompositeEngineFunctions_prepareRATE(CompositeEngine_t *engine, CompositeArguments_t *arguments, CompositeEngineObjectBinding_t *bindings, int nbindings)
Prepares the binding with the RATE coefficients so that they can be used when generating the product.
Definition compositeenginefunctions.c:48

rave_object.h
Generic implementation of an object that is used within rave.

rave_types.h
Type definitions for RAVE.

RaveValueType
RaveValueType
Different value types.
Definition rave_types.h:72

rave_value.h
A value object that can represent standard types like int, double, .

CompositeEngineObjectBinding_t
Binding for associating rave objects with pipelines, sources and other miscellaneous information.
Definition compositeenginebase.h:42

PolarNavigationInfo
Provides user with navigation information.
Definition rave_types.h:160