Skip to content

Commit c4e1df8

Browse files
authored
Merge pull request #528 from gerlero/docs
Update docs
2 parents dfa78cd + f016a9d commit c4e1df8

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

docs/files.rst

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,33 @@ Field files
1313

1414
.. autoclass:: foamlib.FoamFieldFile
1515
:show-inheritance:
16+
17+
.. autoproperty:: foamlib.FoamFieldFile.internal_field
18+
.. autoproperty:: foamlib.FoamFieldFile.boundary_field
19+
.. autoproperty:: foamlib.FoamFieldFile.dimensions
20+
1621

1722
.. autoclass:: foamlib.FoamFieldFile.BoundariesSubDict
1823
:show-inheritance:
1924

2025
.. autoclass:: foamlib.FoamFieldFile.BoundarySubDict
2126
:show-inheritance:
2227

28+
.. autoproperty:: foamlib.FoamFieldFile.BoundarySubDict.value
29+
.. autoproperty:: foamlib.FoamFieldFile.BoundarySubDict.type
30+
2331

24-
Additional types
32+
Supporting types
2533
----------------
2634

2735
.. autoclass:: foamlib.Dimensioned
2836

2937
.. autoclass:: foamlib.DimensionSet
38+
39+
40+
Standalone parsing/serialization
41+
--------------------------------
42+
43+
.. automethod:: foamlib.FoamFile.loads
44+
45+
.. automethod:: foamlib.FoamFile.dumps

0 commit comments

Comments
 (0)