dg::file::NcHyperslab Struct Reference

A NetCDF Hyperslab for SerialNcFile. More...

Public Member Functions
	NcHyperslab (size_t start, size_t count=1)
	{start}, {count}
	NcHyperslab (std::vector< size_t > start, std::vector< size_t > count)
	start, count
template<class File >
	NcHyperslab (const File &file, std::string name)
template<class ContainerType , std::enable_if_t< dg::is_vector_v< ContainerType, dg::SharedVectorTag >, bool > = true>
	NcHyperslab (const ContainerType &data)
	{0 , data.size()}
template<class Topology , std::enable_if_t< !dg::is_vector_v< Topology >, bool > = true>
	NcHyperslab (const Topology &grid)
	grid.start(), grid.count()
template<class T >
	NcHyperslab (size_t start0, const T &param)
	Same as NcHyperslab{ start0, 1, param}
template<class T >
	NcHyperslab (size_t start0, size_t count0, const T &param)
	{start0, NcHyperslab( param).start()}, {count0, NcHyperslab(param).count()}
unsigned	ndim () const
const std::vector< size_t > &	start () const
const std::vector< size_t > &	count () const
std::vector< size_t > &	start ()
std::vector< size_t > &	count ()
const size_t *	startp () const
const size_t *	countp () const

Detailed Description

A NetCDF Hyperslab for SerialNcFile.

This is how to

See also

specify a hyperslab

Attention

When writing variables, NetCDF-C always assumes that the last dimension of the NetCDF variable varies fastest in the given array. This is in contrast to the default behaviour of our dg::evaluate function, which produces vectors where the first dimension of the given grid varies fastest. Thus, when defining variable dimensions the dimension name of the first grid dimension needs to come last.

Note

The unlimited dimension, if present, must be the first dimension.

Constructor & Destructor Documentation

NcHyperslab() [1/7]

dg::file::NcHyperslab::NcHyperslab ( size_t start, size_t count = 1 )

inline

{start}, {count}

One dimensional slab

Parameters

start	the starting position of a 1d variable
count	the count of a 1d variable

NcHyperslab() [2/7]

dg::file::NcHyperslab::NcHyperslab ( std::vector< size_t > start, std::vector< size_t > count )

inline

start, count

start.size() dimensional slab

Parameters

start	specific start vector
count	specific count vector (must have same size as start)

Here is the call graph for this function:

NcHyperslab() [3/7]

template<class File >

dg::file::NcHyperslab::NcHyperslab ( const File & file, std::string name )

inline

{0}, {file.get_dims_shape( file.get_var_dims(name))}

Infer hyperslab from the dimensions of the variable

Parameters

file	Reference to the file object get_dims_shape and get_var_dims are called
name	Name of the variable to inquire

NcHyperslab() [4/7]

template<class ContainerType , std::enable_if_t< dg::is_vector_v< ContainerType, dg::SharedVectorTag >, bool > = true>

dg::file::NcHyperslab::NcHyperslab ( const ContainerType & data )

inline

{0 , data.size()}

A one-dimensional slab

Template Parameters

ContainerType

ContainerType::size() must be callable

Parameters

data	explicitly set one dimensional count

Attention

This only works for one-dimensional data

NcHyperslab() [5/7]

template<class Topology , std::enable_if_t< !dg::is_vector_v< Topology >, bool > = true>

dg::file::NcHyperslab::NcHyperslab ( const Topology & grid )

inline

grid.start(), grid.count()

Template Parameters

Topology

Topolgy::start() and *count() need to return an iterable that can be used to construct std::vector<size_t>

Parameters

grid	explicitly set start and count

Attention

When writing variables, NetCDF-C always assumes that the last dimension of the NetCDF variable varies fastest in the given array. This is in contrast to the default behaviour of our dg::evaluate function, which produces vectors where the first dimension of the given grid varies fastest. Thus, when defining variable dimensions the dimension name of the first grid dimension needs to come last.

Note

The unlimited dimension, if present, must be the first dimension.

NcHyperslab() [6/7]

template<class T >

dg::file::NcHyperslab::NcHyperslab ( size_t start0, const T & param )

inline

Same as NcHyperslab{ start0, 1, param}

NcHyperslab() [7/7]

template<class T >

dg::file::NcHyperslab::NcHyperslab ( size_t start0, size_t count0, const T & param )

inline

{start0, NcHyperslab( param).start()}, {count0, NcHyperslab(param).count()}

Template Parameters

T	NcHyperslab::NcHyperslab<T>(param) must be callable

Parameters

start0	The start coordinate of the unlimited dimension is prepended to NcHyperslab(param)
count0	The count coordinate of the unlimited dimension is prepended to NcHyperslab(param)
param	forwarded to NcHyperslab(param)

Member Function Documentation

count() [1/2]

std::vector< size_t > & dg::file::NcHyperslab::count ( )

inline

Returns

count vector

count() [2/2]

const std::vector< size_t > & dg::file::NcHyperslab::count ( ) const

inline

Returns

count vector

countp()

const size_t * dg::file::NcHyperslab::countp ( ) const

inline

Returns

pointer to first element of count

ndim()

unsigned dg::file::NcHyperslab::ndim ( ) const

inline

Returns

Size of start and count vectors

start() [1/2]

std::vector< size_t > & dg::file::NcHyperslab::start ( )

inline

Returns

start vector

start() [2/2]

const std::vector< size_t > & dg::file::NcHyperslab::start ( ) const

inline

Returns

start vector

startp()

const size_t * dg::file::NcHyperslab::startp ( ) const

inline

Returns

pointer to first element of start

---

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

• nc_hyperslab.h