Skip to content

Commit

Permalink
Update the post doc related to the latest work on CFX face zone refac… (
Browse files Browse the repository at this point in the history
#556)

* Update the post doc related to the latest work on CFX face zone refactoring

* Update the PR : enhance the doc
  • Loading branch information
MichaelNale authored Dec 4, 2023
1 parent 451728f commit 5823c9b
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions src/ansys/dpf/post/fluid_simulation.py
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,10 @@ def cell_zones(self) -> dict:

@property
def face_zones(self) -> dict:
"""Return a dictionary of the face zones in the simulation."""
"""Return a dictionary of the face zones in the simulation.
For CFX files, we gather face zones in COMPOSITE entities more physics-related.
"""
return self.mesh_info.face_zones

@property
Expand Down Expand Up @@ -558,7 +561,8 @@ def density(
node_ids:
List of IDs of nodes to get results for.
face_ids:
List of IDs of faces to get results for.
List of faces IDs to get results for. For CFX files, these IDs correspond
to the COMPOSITE that gathers the related face zones.
cell_ids:
List of IDs of cells to get results for.
zone_ids:
Expand Down

0 comments on commit 5823c9b

Please sign in to comment.