Skip to content

API: Inquire what objects are available in the registry #8

Description

@MakisH

In the Quickstart example, I see:

# --- Calculate and write volume of alpha.water ---
alpha = volScalarField.from_registry(self.mesh, "alpha.water")  # Get alpha.water field

To write this, one need to know that there is a field called (exactly) alpha.water. I guess this is a reasonable assumption for someone working with the OpenFOAM code itself, but for someone doing mainly post-processing, having an easy way to inquire what fields are available to use would be useful.

Not sure if this is already in the API, but it would be useful to have such a registry.toc() or method, which would return the list of object names. It would also be great to know what their type is.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions