dg::file::Record< SignatureType, Attributes > Struct Template Reference

A realisation of the Record concept. Helper to generate NetCDF variables. More...

Public Types
using	Signature = SignatureType
	Signature of the function.

Public Attributes
std::string	name
	Name of the variable to create.
Attributes	atts
	Attributes of the variable: "long_name" is strongly recommended.
std::function< Signature >	function
	The function to call that generates data for the variable.

Detailed Description

template<class SignatureType, class Attributes = std::map<std::string, nc_att_t>>
struct dg::file::Record< SignatureType, Attributes >

A realisation of the Record concept. Helper to generate NetCDF variables.

Supposed to be used to generate variable lists to write to NetCDF

std::vector<dg::file::Record<void(dg::x::DVec&,const dg::x::CartesianGrid3d&,double),
    dg::file::LongNameAttribute>> records = {
    {"vectorX", "X-component of vector",
        [] ( dg::x::DVec& resultD, const dg::x::CartesianGrid3d& g, double time){
            resultD = dg::evaluate( gradientX, g);
            dg::blas1::scal( resultD, cos( time));
        }
    },
    {"vectorY", "Y-component of vector",
        [] ( dg::x::DVec& resultD, const dg::x::CartesianGrid3d& g, double time){
            resultD = dg::evaluate( gradientY, g);
            dg::blas1::scal( resultD, cos( time));
        }
    },
    {"vectorZ", "Z-component of vector",
        [] ( dg::x::DVec& resultD, const dg::x::CartesianGrid3d& g, double time){
            resultD = dg::evaluate( gradientZ, g);
            dg::blas1::scal( resultD, cos( time));
        }
    }
};

Template Parameters

SignatureType	Signature of the callable function
Attributes	Type of the attributes list, needs to be Iterable i.e. begin() and end() (e.g. dg::file::LongNameAttribute)

See also

For the list of recommended variable attributes see Attribute Convenctions

Member Typedef Documentation

Signature

template<class SignatureType , class Attributes = std::map<std::string, nc_att_t>>

using dg::file::Record< SignatureType, Attributes >::Signature = SignatureType

Signature of the function.

Member Data Documentation

atts

template<class SignatureType , class Attributes = std::map<std::string, nc_att_t>>

Attributes dg::file::Record< SignatureType, Attributes >::atts

Attributes of the variable: "long_name" is strongly recommended.

function

template<class SignatureType , class Attributes = std::map<std::string, nc_att_t>>

std::function<Signature> dg::file::Record< SignatureType, Attributes >::function

The function to call that generates data for the variable.

name

template<class SignatureType , class Attributes = std::map<std::string, nc_att_t>>

std::string dg::file::Record< SignatureType, Attributes >::name

Name of the variable to create.

---

The documentation for this struct was generated from the following file:

• records.h