cf.Field.dump

Field.dump(id=None)

Return a string containing a full description of the instance.

Parameters :
id : str, optional

Set the common prefix of component names. By default the instance’s class name is used.

Returns :
out : str

A string containing the description.

Examples

>>> x = f.dump()
>>> print f.dump()
>>> print f.dump(id='pressure_field')

Previous topic

cf.Field.delprop

Next topic

cf.Field.equals

This Page