feat: exposing quantity types in PyDPF Core

[a-bouth]

Exposing the quantity_typefor FieldsDefinition

Main Changes

• Added calls to the C API in field_definition_capi.py
• Adding methods in field_definition.py
• • Note: I initially wanted to use a @property decorator for quantity_type, but it turns out that the getter needs an index, which we cannot specify with the @property decorator. I opted for defining explicits get_quantity_type(index) and set_quantity_type() methods. Please let me know if I should do it differently.
• • Also exposed is_of_quantity_type() and get_num_quantity_types_available()
• Added corresponding test in test_field.py (I found other tests for FieldDefinition here, but maybe that's not the best place ?)

[codecov]

Codecov Report

Attention: Patch coverage is 30.76923% with 9 lines in your changes missing coverage. Please review.

Project coverage is 50.56%. Comparing base (60140b1) to head (d1a7e88).

Additional details and impacted files

@@             Coverage Diff             @@
##           master    #1965       +/-   ##
===========================================
- Coverage   88.35%   50.56%   -37.80%     
===========================================
  Files          89       89               
  Lines       10242    10255       +13     
===========================================
- Hits         9049     5185     -3864     
- Misses       1193     5070     +3877     

[cbellot000]

Maybe having just one property which returns the quantity_types would be easier too use, what do you think?

[cbellot000]

[like] Camille Bellot reacted to your message:

________________________________ From: Alexandre Bouthéon ***@***.***> Sent: Friday, December 13, 2024 9:34:58 AM To: ansys/pydpf-core ***@***.***> Cc: Camille Bellot ***@***.***>; Mention ***@***.***> Subject: Re: [ansys/pydpf-core] feat: exposing quantity types in PyDPF Core (PR #1965) [External Sender] @a-bouth commented on this pull request.

________________________________ In src/ansys/dpf/core/field_definition.py<#1965 (comment)>:

+ raise ValueError("Index must be greater than or equal to 0")

+ + quantity_type = self._api.csfield_definition_get_quantity_type(self, index) + return str(quantity_type) + + def set_quantity_type(self, quantity_type): + """Setter for Quantity Type + + Parameters + ---------- + quantity_type: Quantity Type + Quantity type to set + """ + self._api.csfield_definition_set_quantity_type(self, quantity_type) + + def get_num_available_quantity_types(self): @cbellot000<https://github.com/cbellot000> done — Reply to this email directly, view it on GitHub<#1965 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ATF7SHXXBBRJOOB67UUCIEL2FKS4FAVCNFSM6AAAAABTPFTM5KVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDKMBRHAZTSNBXGA>. You are receiving this because you were mentioned.Message ID: ***@***.***>