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', 'none', 'invalid']¶
-
TrueStrings
= ['on', 'yes', 'true']¶
-
__dict__
= mappingproxy({'__weakref__': <attribute '__weakref__' of 'BoolProxy' objects>, '__init__': <function BoolProxy.__init__>, '__doc__': 'Wraps a boolean parsed from a file. Optionally stores a textual\n representation\n ', '__str__': <function BoolProxy.__str__>, '__bool__': <function BoolProxy.__bool__>, 'FalseStrings': ['off', 'no', 'false', 'none', 'invalid'], '__eq__': <function BoolProxy.__eq__>, '__dict__': <attribute '__dict__' of 'BoolProxy' objects>, '__hash__': None, '__repr__': <function BoolProxy.__repr__>, '__module__': 'PyFoam.Basics.DataStructures', '__nonzero__': <function BoolProxy.__nonzero__>, 'TrueStrings': ['on', 'yes', 'true']})¶
-
__hash__
= None¶
-
__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__
= mappingproxy({'__dict__': <attribute '__dict__' of 'Codestream' objects>, '__module__': 'PyFoam.Basics.DataStructures', '__weakref__': <attribute '__weakref__' of 'Codestream' objects>, '__doc__': 'A class that encapsulates an codestream string', '__str__': <function Codestream.__str__>})¶
-
__module__
= 'PyFoam.Basics.DataStructures'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
-
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__
= mappingproxy({'__delitem__': <function DictProxy.__delitem__>, '__setitem__': <function DictProxy.__setitem__>, '__init__': <function DictProxy.__init__>, 'keys': <function DictProxy.keys>, 'addDecoration': <function DictProxy.addDecoration>, '__module__': 'PyFoam.Basics.DataStructures', 'update': <function DictProxy.update>, 'addRedirection': <function DictProxy.addRedirection>, '__str__': <function DictProxy.__str__>, '_DictProxy__enforceString': <function DictProxy.__enforceString>, '__getitem__': <function DictProxy.__getitem__>, 'isRegexp': <function DictProxy.isRegexp>, 'getDecoration': <function DictProxy.getDecoration>, '__dict__': <attribute '__dict__' of 'DictProxy' objects>, '__weakref__': <attribute '__weakref__' of 'DictProxy' objects>, '__doc__': 'A class that acts like a dictionary, but preserves the order\n of the entries. Used to beautify the output', '__deepcopy__': <function DictProxy.__deepcopy__>, 'iteritems': <function DictProxy.iteritems>, 'items': <function DictProxy.items>, 'getRegexpValue': <function DictProxy.getRegexpValue>, '__iter__': <function DictProxy.__iter__>, '__contains__': <function DictProxy.__contains__>})¶
-
__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__
= mappingproxy({'__weakref__': <attribute '__weakref__' of 'DictRedirection' objects>, '__init__': <function DictRedirection.__init__>, '__doc__': 'This class is in charge of handling redirections to other directories', 'getContent': <function DictRedirection.getContent>, '__float__': <function DictRedirection.__float__>, '__str__': <function DictRedirection.__str__>, 'useAsRedirect': <function DictRedirection.useAsRedirect>, '__module__': 'PyFoam.Basics.DataStructures', '__dict__': <attribute '__dict__' of 'DictRedirection' objects>, 'keys': <function DictRedirection.keys>, '__call__': <function DictRedirection.__call__>})¶
-
__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
-
__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__
= mappingproxy({'__weakref__': <attribute '__weakref__' of 'FoamDataType' objects>, '__doc__': None, '__lt__': <function FoamDataType.__lt__>, '__module__': 'PyFoam.Basics.DataStructures', '__eq__': <function FoamDataType.__eq__>, '__gt__': <function FoamDataType.__gt__>, '__hash__': None, '__repr__': <function FoamDataType.__repr__>, '__ge__': <function FoamDataType.__ge__>, '__dict__': <attribute '__dict__' of 'FoamDataType' objects>, '__le__': <function FoamDataType.__le__>, '__ne__': <function FoamDataType.__ne__>})¶
-
__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
-
__hash__
= None¶
-
__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
-
__module__
= 'PyFoam.Basics.DataStructures'¶
-
-
class
PyFoam.Basics.DataStructures.
Tensor
(v1, v2, v3, v4, v5, v6, v7, v8, v9)[source]¶ Bases:
PyFoam.Basics.DataStructures.FixedLength
-
__module__
= 'PyFoam.Basics.DataStructures'¶
-
-
class
PyFoam.Basics.DataStructures.
TupleProxy
(tup=())[source]¶ Bases:
list
Enables Tuples to be manipulated
-
__dict__
= mappingproxy({'__dict__': <attribute '__dict__' of 'TupleProxy' objects>, '__module__': 'PyFoam.Basics.DataStructures', '__init__': <function TupleProxy.__init__>, '__doc__': 'Enables Tuples to be manipulated', '__weakref__': <attribute '__weakref__' of 'TupleProxy' objects>})¶
-
__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__
= mappingproxy({'__weakref__': <attribute '__weakref__' of 'Unparsed' objects>, '__init__': <function Unparsed.__init__>, '__doc__': 'A class that encapsulates an unparsed string', 'toNumpy': <function Unparsed.toNumpy>, '__lt__': <function Unparsed.__lt__>, '__str__': <function Unparsed.__str__>, '__hash__': <function Unparsed.__hash__>, '__module__': 'PyFoam.Basics.DataStructures', '__dict__': <attribute '__dict__' of 'Unparsed' objects>})¶
-
__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__
= mappingproxy({'__weakref__': <attribute '__weakref__' of 'UnparsedList' objects>, '__init__': <function UnparsedList.__init__>, '__doc__': 'A class that encapsulates a list that was not parsed for\n performance reasons', 'toNumpy': <function UnparsedList.toNumpy>, '__lt__': <function UnparsedList.__lt__>, '__module__': 'PyFoam.Basics.DataStructures', '__hash__': None, '__eq__': <function UnparsedList.__eq__>, '__dict__': <attribute '__dict__' of 'UnparsedList' objects>, '__cmp__': <function UnparsedList.__cmp__>, '__len__': <function UnparsedList.__len__>})¶
-
__hash__
= None¶
-
__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'¶
-