Source code for butterfly.U

# coding=utf-8
"""U class."""
from foamfile import FoamFileZeroFolder, foam_file_from_file
from collections import OrderedDict


class U(FoamFileZeroFolder):
    """U (Speed) class."""

    # set default valus for this class
    __default_values = OrderedDict()
    __default_values['dimensions'] = '[0 1 -1 0 0 0 0]'
    __default_values['#include'] = None
    __default_values['internalField'] = 'uniform (0 0 0)'
    __default_values['boundaryField'] = {}

    def __init__(self, values=None):
        """Init class."""
        FoamFileZeroFolder.__init__(self, name='U', cls='volVectorField',
                                    location='0',
                                    default_values=self.__default_values,
                                    values=values)

    @classmethod
    def from_file(cls, filepath):
        """Create a FoamFile from a file.

        Args:
            filepath: Full file path to dictionary.
        """
        return cls(values=foam_file_from_file(filepath, cls.__name__))