Improve FieldInfo interface.

[prmukherj]

📝 Description of the feature

field_info.get_fields_info() or field_info.get_surfaces_info() returns a raw data structure (i.e. a dictionary). We need this interface to return a list of Field or SurfaceInfo objects with the contained data.

💡 Steps for implementing the feature

🔗 Useful links and references

No response

[prmukherj]

 >>> import ansys.fluent.core as pyfluent
 >>> solver = pyfluent.launch_fluent(mode="solver")
 >>> solver.file.read(file_type="case-dats", file_name=mixing_elbow_case_path)
 >>> solver.solution.initialization.hybrid_initialize()
 >>> field_info = solver.field_info
 >>> field_info.get_fields_info()
 >>> field_info.get_surfaces_info()

[RebelYoung]

Hello, I found it is completely different from field_data in 0.11.0.
The construction of FieldData changed.
Especially, it show in help() function.
e.g.
In 0.11.0: help(solver.field_data.get_scalar_field_data)

Help on method get_scalar_field_data in module ansys.fluent.core.services.field_data:

get_scalar_field_data(surface_name: str, field_name: str, node_value: Union[bool, NoneType] = True, boundary_value: Union[bool, NoneType] = False) -> Dict[int, <built-in function array>] method of ansys.fluent.core.services.field_data.FieldData instance
    Get scalar field data on a surface.
    
    Parameters
    ----------
    surface_name : str
        Name of the surface.
    field_name : str
        Name of the scalar field.
    node_value : bool, optional
        Whether to provide data for the nodal location. The default is ``True``.
        When ``False``, data is provided for the element location.
    boundary_value : bool, optional
        Whether to provide slip velocity at the wall boundaries. The default is
        ``False``. When ``True``, no slip velocity is provided.
    
    Returns
    -------
    Dict[int, np.array]
        Dictionary containing a map of surface IDs to the scalar field.

In 0.12.dev:

Help on _FieldMethod in FieldData object:

FieldData.get_scalar_field_data = class _FieldMethod(builtins.object)
 |  FieldData.get_scalar_field_data(field_data_accessor, args_allowed_values_accessors)
 |  
 |  Methods defined here:
 |  
 |  __call__(self, *args, **kwargs)
 |      Call self as a function.
 |  
 |  __init__(self, field_data_accessor, args_allowed_values_accessors)
 |      Initialize self.  See help(type(self)) for accurate signature.
 |  
 |  ----------------------------------------------------------------------
 |  Data descriptors defined here:
 |  
 |  __dict__
 |      dictionary for instance variables (if defined)
 |  
 |  __weakref__
 |      list of weak references to the object (if defined)

I think it is difficult for reading and debugging.

[RebelYoung]

In 0.11.0, I have a stable workflow to process the field_data.
e.g.

1. get_surface_data # from surface names to id,xy coordinate or get_surface_info() to get id
2. create a Dict of all data I need

field_data.add_get_scalar_fields_request([up_id,down_id],'pressure')
field_data.add_get_scalar_fields_request([up_id,down_id],'pressure-coefficient')
field_data.add_get_scalar_fields_request([up_id,down_id],'skin-friction-coef')
data=field_data.get_fields() # create a Dict to integrate all the properties data I need.

However it is a wrong way in the lastest version.

[dnwillia-work]

I've got to agree (regarding your comment about the current help). It's much less useful than it used to be. Strange that it's not working since the old help text is still there:

https://github.com/pyansys/pyfluent/blob/939ad5162ff769c8675368b95c1ed14ca47300e3/src/ansys/fluent/core/services/field_data.py#L846

[RebelYoung]

I've got to agree (regarding your comment about the current help). It's much less useful than it used to be. Strange that it's not working since the old help text is still there:

https://github.com/pyansys/pyfluent/blob/939ad5162ff769c8675368b95c1ed14ca47300e3/src/ansys/fluent/core/services/field_data.py#L846

Yes, I can read in source.
However I don't know why I can not jump to source code in PyCharm. It works in VS code.
So if the help function outputing no enough information as the old version, it would be more difficult for me to debugging my codes.

[dnwillia-work]

@seanpearsonuk @ajain-work Looks like the documentation is broken right?

[pyansys-automation]

Hello @seanpearsonuk!
This issue has been open for over a year and has had no updates in the past 8 months. If it is still relevant, please provide an update. Otherwise, consider closing it to help keep the issue tracker clean.

If this issue needs to remain open, please comment below with @pyansys-automation never close issue to prevent it from being automatically closed.

If you want this repository to be excluded from this automated maintenance process, please let us know by filling in the opt-out request form.

[prmukherj]

This is the new structure of field info within field data. So this task is not relevant any more.

#4478

cc. @seanpearsonuk