Source code for epygram.fields.H2DVectorField
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Copyright (c) Météo France (2014-)
# This software is governed by the CeCILL-C license under French law.
# http://www.cecill.info
"""
Contains the class for a Horizontal 2D Vector field.
"""
from __future__ import print_function, absolute_import, unicode_literals, division
from footprints import FPList
from epygram.base import FieldValidityList
from .D3VectorField import D3VectorField
[docs]class H2DVectorField(D3VectorField):
"""
Horizontal 2-Dimensions Vector field class.
This is a wrapper to a list of H2DField(s), representing the components
of a vector projected on its geometry (the grid axes).
"""
_collector = ('field',)
_footprint = dict(
attr=dict(
structure=dict(
info="Type of Field geometry.",
values=set(['H2D'])),
vector=dict(
info="Intrinsic vectorial nature of the field.",
type=bool,
values=set([True])),
validity=dict(
info="Validity of the field.",
type=FieldValidityList,
optional=True,
access='rwx',
default=FieldValidityList()),
components=dict(
info="List of Fields that each compose a component of the vector.",
type=FPList,
optional=True,
default=FPList([])),
processtype=dict(
optional=True,
info="Generating process.")
)
)
###################
# PRE-APPLICATIVE #
###################
# (but useful and rather standard) !
# [so that, subject to continuation through updated versions,
# including suggestions/developments by users...]