feat: improve and update of geos-mesh utils functions #109
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ckdataset if it exist
paloma-martinez
requested changes
Jul 11, 2025
Co-authored-by: paloma-martinez <[email protected]>
paloma-martinez
approved these changes
Jul 25, 2025
Comment on lines
+49
to
+50
| nb_component (int): Nb of components. | ||
| nb_elements (int): Nb of elements. |
There was a problem hiding this comment.
Suggested change
| nb_component (int): Nb of components. | |
| nb_elements (int): Nb of elements. | |
| nb_component (int): Number of components. | |
| nb_elements (int): Number of elements. |
| Defaults to False. | ||
| value (any, optional): value to fill in the partial atribute. | ||
| Defaults to nan. For int vtk array, default value is automatically set to -1. | ||
| value (Any, optional): Filling value. It is better to use numpy scalar type for the values. |
There was a problem hiding this comment.
Suggested change
| value (Any, optional): Filling value. It is better to use numpy scalar type for the values. | |
| value (Any, optional): Filling value. It is recommended to use numpy scalar type for the values. |
| attributeName (str): name of the attribute. | ||
| componentNames (tuple[str,...], optional): name of the components for vectorial attributes. If one component, give an empty tuple. | ||
| object (vtkDataObject): Object (vtkMultiBlockDataSet, vtkDataSet) where to create the attribute. | ||
| listValues (list[Any]): List of values of the attribute for each components. It is better to use numpy scalar type for the values. |
There was a problem hiding this comment.
Suggested change
| listValues (list[Any]): List of values of the attribute for each components. It is better to use numpy scalar type for the values. | |
| listValues (list[Any]): List of values of the attribute for each components. It is recommended to use numpy scalar type for the values. |
| ) -> bool: | ||
| """Create an attribute with a constant value everywhere if absent. | ||
| """Create a new attribute with a constant value per component on every blocks of the multiBlockDataSet. |
There was a problem hiding this comment.
Suggested change
| """Create a new attribute with a constant value per component on every blocks of the multiBlockDataSet. | |
| """Create a new attribute with a constant value per component on every block of the multiBlockDataSet. |
| attributeName (str): name of the attribute. | ||
| componentNames (tuple[str,...], optional): name of the components for vectorial attributes. If one component, give an empty tuple. | ||
| multiBlockDataSet (vtkMultiBlockDataSet | vtkCompositeDataSet): MultiBlockDataSet where to create the attribute. | ||
| listValues (list[Any]): List of values of the attribute for each components. It is better to use numpy scalar type for the values. |
There was a problem hiding this comment.
Suggested change
| listValues (list[Any]): List of values of the attribute for each components. It is better to use numpy scalar type for the values. | |
| listValues (list[Any]): List of values of the attribute for each components. It is recommended to use numpy scalar type for the values. |
| logger.warning( | ||
| f"During the creation of the constant attribute { attributeName }, values will be converted from { valueType } to { npType }." | ||
| ) | ||
| logger.warning( "To avoid any issue with the conversion use directly numpy scalar type for the values" ) |
There was a problem hiding this comment.
Suggested change
| logger.warning( "To avoid any issue with the conversion use directly numpy scalar type for the values" ) | |
| logger.warning( "To avoid any issue with the conversion, please use directly numpy scalar type for the values" ) |
| logger.warning( "To avoid any issue with the conversion use directly numpy scalar type for the values" ) | ||
| valueType = npType | ||
|
|
||
| # Check the coherency between the given value type and the vtk array type if it exist. |
There was a problem hiding this comment.
Suggested change
| # Check the coherency between the given value type and the vtk array type if it exist. | |
| # Check the consistency between the given value type and the vtk array type if it exists. |
| vtkDataType (Union[int, None], optional): Vtk data type of the attribute to create. | ||
| Defaults to None, the vtk data type is given by the type of the array. | ||
|
|
||
| Warning with int8, uint8 and int64 type, the vtk data type corresponding are multiples. By default: |
There was a problem hiding this comment.
Suggested change
| Warning with int8, uint8 and int64 type, the vtk data type corresponding are multiples. By default: | |
| Warning with int8, uint8 and int64 type, the corresponding vtk data type are multiples. By default: |
| vtkDataType (Union[int, None], optional): Vtk data type of the attribute to create. | ||
| Defaults to None, the vtk data type is given by the type of the values. | ||
|
|
||
| Warning with int8, uint8 and int64 type of value, the vtk data type corresponding are multiples. By default: |
There was a problem hiding this comment.
Suggested change
| Warning with int8, uint8 and int64 type of value, the vtk data type corresponding are multiples. By default: | |
| Warning with int8, uint8 and int64 type of value, the corresponding vtk data type are multiples. By default: |
| vtkDataType (Union[int, None], optional): Vtk data type of the attribute to create. | ||
| Defaults to None, the vtk data type is given by the type of the values. | ||
|
|
||
| Warning with int8, uint8 and int64 type of value, the vtk data type corresponding are multiples. By default: |
There was a problem hiding this comment.
Suggested change
| Warning with int8, uint8 and int64 type of value, the vtk data type corresponding are multiples. By default: | |
| Warning with int8, uint8 and int64 type of value, the corresponding vtk data type are multiples. By default: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the utils functions of geos-mesh:
close #108