FEAT: Improve consistency

[Devin-Crawford]

Description

Add method modeler.get_objects_by_name to be consistent with modeler.get_objects_by_material

Issue linked

Close #7257

Checklist

• I have tested my changes locally.
• I have added necessary documentation or updated existing documentation.
• I have followed the coding style guidelines of this project.
• I have added appropriate tests (unit, integration, system).
• I have reviewed my changes before submitting this pull request.
• I have linked the issue or issues that are solved by the PR if any.
• I have agreed with the Contributor License Agreement (CLA).

[SMoraisAnsys]

Should we rework the API to work differently ? Like having a single method to do both approaches ? We could allow different kind of matching mechanism, e.g. (exact, contains, start/endswith, regex), whille keeping the pattern argument (meaning varying depending on the matching mechanism) and en/disabling case sensitive.

Open to discussion

[SMoraisAnsys]

Any thoughts on my comment @Devin-Crawford @Samuelopez-ansys @MaxJPRey (you reviewed, blame yourself for the ping :p)

[Samuelopez-ansys]

I think it should raise an Exception

[Devin-Crawford]

I agree.

Suggested change

	self.logger.error("Input file does not exist.")
	error_message = f"Input file '{in_file}' does not exist."
	self.logger.error(error_message)
	raise FileNotFoundError(error_message)

[Samuelopez-ansys]

Should we rework the API to work differently ? Like having a single method to do both approaches ? We could allow different kind of matching mechanism, e.g. (exact, contains, start/endswith, regex), whille keeping the pattern argument (meaning varying depending on the matching mechanism) and en/disabling case sensitive.

Open to discussion

What do you mean @SMoraisAnsys ?

get_objects_by_name and get_object_from_name?

I would keep get_object_from_name which already exist, and I would add a new argument to specify if you want a perfect match (like now) or partial (with Sebastien's ideas).

[Devin-Crawford]

Should we rework the API to work differently ? Like having a single method to do both approaches ? We could allow different kind of matching mechanism, e.g. (exact, contains, start/endswith, regex), whille keeping the pattern argument (meaning varying depending on the matching mechanism) and en/disabling case sensitive.
Open to discussion

What do you mean @SMoraisAnsys ?

get_objects_by_name and get_object_from_name?

I would keep get_object_from_name which already exist, and I would add a new argument to specify if you want a perfect match (like now) or partial (with Sebastien's ideas).

• get_objects_by_material() returns a list of objects.
• get_object_from_name() returns a single object and the name must be specified exactly.
• get_objects_by_name() is new and is consistent with the first method above. There
  are two inconsistencies: "from" vs "by". It doesn't matter which preposition
  is used but they should
  be consistent. get_object_from_name() wouldn't be necessary if we
  have get_objects_by_name(). We could add a named argument exact_match to return only
  a single object and then we would have get_object_from_name() functionality.