cf.FieldList.roll

FieldList.roll(axis, shift, i=False, **kwargs)

Roll each field along a cylcic axis.

Parameters:

axis, kwargs : optional

Select the axis to be rolled. See cf.Field.roll for details.

shift : int

The number of places by which the selected cyclic axis is to be rolled. See cf.Field.roll for details.

i : bool, optional

If True then update the field list and its fields in place. By default a new field list containing new fields is created.

Returns:

out : cf.FieldList