cf.AuxiliaryCoordinate.dump¶
-
AuxiliaryCoordinate.
dump
(display=True, omit=(), domain=None, key=None, _level=0)[source]¶ Return a string containing a full description of the coordinate.
Parameters: - display : bool, optional
If False then return the description as a string. By default the description is printed, i.e.
c.dump()
is equivalent toprint c.dump(display=False)
.- omit : sequence of strs
Omit the given CF properties from the description.
Returns: - out : None or str
A string containing the description.
Examples: