PyFoam.Basics.DataStructures module¶
Data structures in Foam-Files that can’t be directly represented by Python-Structures
-
class
PyFoam.Basics.DataStructures.
BinaryBlob
(data)[source]¶ Bases:
PyFoam.Basics.DataStructures.Unparsed
Represents a part of the file with binary data in it
-
__module__
= 'PyFoam.Basics.DataStructures'¶
-
-
class
PyFoam.Basics.DataStructures.
BinaryList
(lngth, data)[source]¶ Bases:
PyFoam.Basics.DataStructures.UnparsedList
A class that represents a list that is saved as binary data
-
__module__
= 'PyFoam.Basics.DataStructures'¶
-
-
class
PyFoam.Basics.DataStructures.
BoolProxy
(val=None, textual=None)[source]¶ Bases:
object
Wraps a boolean parsed from a file. Optionally stores a textual representation
-
FalseStrings
= ['off', 'no', 'false', 'invalid']¶
-
TrueStrings
= ['on', 'yes', 'true']¶
-
__dict__
= dict_proxy({'__module__': 'PyFoam.Basics.DataStructures', '__nonzero__': <function __nonzero__>, 'TrueStrings': ['on', 'yes', 'true'], '__str__': <function __str__>, '__dict__': <attribute '__dict__' of 'BoolProxy' objects>, '__weakref__': <attribute '__weakref__' of 'BoolProxy' objects>, '__repr__': <function __repr__>, '__bool__': <function __bool__>, 'FalseStrings': ['off', 'no', 'false', 'invalid'], '__eq__': <function __eq__>, '__doc__': 'Wraps a boolean parsed from a file. Optionally stores a textual\n representation\n ', '__init__': <function __init__>})¶
-
__init__
(val=None, textual=None)[source]¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
__module__
= 'PyFoam.Basics.DataStructures'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
-
class
PyFoam.Basics.DataStructures.
Codestream
[source]¶ Bases:
str
A class that encapsulates an codestream string
-
__dict__
= dict_proxy({'__dict__': <attribute '__dict__' of 'Codestream' objects>, '__module__': 'PyFoam.Basics.DataStructures', '__str__': <function __str__>, '__doc__': 'A class that encapsulates an codestream string'})¶
-
__module__
= 'PyFoam.Basics.DataStructures'¶
-
-
class
PyFoam.Basics.DataStructures.
DictProxy
[source]¶ Bases:
dict
A class that acts like a dictionary, but preserves the order of the entries. Used to beautify the output
-
_DictProxy__enforceString
(v, toString)¶
-
__dict__
= dict_proxy({'__module__': 'PyFoam.Basics.DataStructures', 'getRegexpValue': <function getRegexpValue>, '__getitem__': <function __getitem__>, 'keys': <function keys>, '__deepcopy__': <function __deepcopy__>, '__str__': <function __str__>, 'update': <function update>, '__iter__': <function __iter__>, 'iteritems': <function iteritems>, '__dict__': <attribute '__dict__' of 'DictProxy' objects>, '__weakref__': <attribute '__weakref__' of 'DictProxy' objects>, '__init__': <function __init__>, 'isRegexp': <function isRegexp>, '__delitem__': <function __delitem__>, 'addDecoration': <function addDecoration>, 'addRedirection': <function addRedirection>, '__contains__': <function __contains__>, 'items': <function items>, '__setitem__': <function __setitem__>, '__doc__': 'A class that acts like a dictionary, but preserves the order\n of the entries. Used to beautify the output', 'getDecoration': <function getDecoration>, '_DictProxy__enforceString': <function __enforceString>})¶
-
__module__
= 'PyFoam.Basics.DataStructures'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
-
class
PyFoam.Basics.DataStructures.
DictRedirection
(fullCopy, reference, name)[source]¶ Bases:
object
This class is in charge of handling redirections to other directories
-
__dict__
= dict_proxy({'__module__': 'PyFoam.Basics.DataStructures', '__dict__': <attribute '__dict__' of 'DictRedirection' objects>, 'keys': <function keys>, '__str__': <function __str__>, 'useAsRedirect': <function useAsRedirect>, '__call__': <function __call__>, 'getContent': <function getContent>, '__weakref__': <attribute '__weakref__' of 'DictRedirection' objects>, '__doc__': 'This class is in charge of handling redirections to other directories', '__init__': <function __init__>, '__float__': <function __float__>})¶
-
__init__
(fullCopy, reference, name)[source]¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
__module__
= 'PyFoam.Basics.DataStructures'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
-
class
PyFoam.Basics.DataStructures.
Dimension
(*dims)[source]¶ Bases:
PyFoam.Basics.DataStructures.FoamDataType
-
__module__
= 'PyFoam.Basics.DataStructures'¶
-
-
class
PyFoam.Basics.DataStructures.
Field
(val, name=None, length=None)[source]¶ Bases:
PyFoam.Basics.DataStructures.FoamDataType
-
__init__
(val, name=None, length=None)[source]¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
__module__
= 'PyFoam.Basics.DataStructures'¶
-
-
class
PyFoam.Basics.DataStructures.
FixedLength
(vals)[source]¶ Bases:
PyFoam.Basics.DataStructures.FoamDataType
-
__module__
= 'PyFoam.Basics.DataStructures'¶
-
-
class
PyFoam.Basics.DataStructures.
FoamDataType
[source]¶ Bases:
object
-
__dict__
= dict_proxy({'__ne__': <function __ne__>, '__module__': 'PyFoam.Basics.DataStructures', '__weakref__': <attribute '__weakref__' of 'FoamDataType' objects>, '__le__': <function __le__>, '__repr__': <function __repr__>, '__gt__': <function __gt__>, '__dict__': <attribute '__dict__' of 'FoamDataType' objects>, '__lt__': <function __lt__>, '__eq__': <function __eq__>, '__doc__': None, '__ge__': <function __ge__>})¶
-
__eq__
(other)[source]¶ Implementation to make __cmp__ work again in Python3
Implementing this method means that these objects are not hashable. But that is OK
-
__module__
= 'PyFoam.Basics.DataStructures'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
-
class
PyFoam.Basics.DataStructures.
SymmTensor
(v1, v2, v3, v4, v5, v6)[source]¶ Bases:
PyFoam.Basics.DataStructures.FixedLength
-
__init__
(v1, v2, v3, v4, v5, v6)[source]¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
__module__
= 'PyFoam.Basics.DataStructures'¶
-
-
class
PyFoam.Basics.DataStructures.
Tensor
(v1, v2, v3, v4, v5, v6, v7, v8, v9)[source]¶ Bases:
PyFoam.Basics.DataStructures.FixedLength
-
__init__
(v1, v2, v3, v4, v5, v6, v7, v8, v9)[source]¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
__module__
= 'PyFoam.Basics.DataStructures'¶
-
-
class
PyFoam.Basics.DataStructures.
TupleProxy
(tup=())[source]¶ Bases:
list
Enables Tuples to be manipulated
-
__dict__
= dict_proxy({'__dict__': <attribute '__dict__' of 'TupleProxy' objects>, '__module__': 'PyFoam.Basics.DataStructures', '__weakref__': <attribute '__weakref__' of 'TupleProxy' objects>, '__doc__': 'Enables Tuples to be manipulated', '__init__': <function __init__>})¶
-
__module__
= 'PyFoam.Basics.DataStructures'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
-
class
PyFoam.Basics.DataStructures.
Unparsed
(data)[source]¶ Bases:
object
A class that encapsulates an unparsed string
-
__dict__
= dict_proxy({'__dict__': <attribute '__dict__' of 'Unparsed' objects>, '__module__': 'PyFoam.Basics.DataStructures', '__hash__': <function __hash__>, '__str__': <function __str__>, 'toNumpy': <function toNumpy>, '__weakref__': <attribute '__weakref__' of 'Unparsed' objects>, '__lt__': <function __lt__>, '__init__': <function __init__>, '__doc__': 'A class that encapsulates an unparsed string'})¶
-
__module__
= 'PyFoam.Basics.DataStructures'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
-
class
PyFoam.Basics.DataStructures.
UnparsedList
(lngth, data)[source]¶ Bases:
object
A class that encapsulates a list that was not parsed for performance reasons
-
__dict__
= dict_proxy({'__module__': 'PyFoam.Basics.DataStructures', '__weakref__': <attribute '__weakref__' of 'UnparsedList' objects>, 'toNumpy': <function toNumpy>, '__cmp__': <function __cmp__>, '__len__': <function __len__>, '__dict__': <attribute '__dict__' of 'UnparsedList' objects>, '__lt__': <function __lt__>, '__eq__': <function __eq__>, '__doc__': 'A class that encapsulates a list that was not parsed for\n performance reasons', '__init__': <function __init__>})¶
-
__module__
= 'PyFoam.Basics.DataStructures'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
-
class
PyFoam.Basics.DataStructures.
Vector
(x, y, z)[source]¶ Bases:
PyFoam.Basics.DataStructures.FixedLength
-
__module__
= 'PyFoam.Basics.DataStructures'¶
-