Skip to content

Commit

Permalink
MAINT: Update code from ADO - 0.6.0.dev5 (#742)
Browse files Browse the repository at this point in the history
  • Loading branch information
@rchopade7
rchopade7 authored Mar 19, 2024
1 parent d8fa786 commit a969b86
Show file tree
Hide file tree
Showing 73 changed files with 8,647 additions and 1,642 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci_cd.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ on:

env:
DOCKER_IMAGE_NAME: ghcr.io/ansys/prime
DOCKER_IMAGE_TAG: '24.2.0.dev4'
DOCKER_IMAGE_TAG: '24.2.0.dev5'
MAIN_PYTHON_VERSION: '3.9'
PACKAGE_NAME: 'ansys-meshing-prime'
PACKAGE_NAMESPACE: 'ansys.meshing.prime'
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"

[project]
name = "ansys-meshing-prime"
version = "0.6.0.dev4"
version = "0.6.0.dev5"
description = "PyPrimeMesh is a Python client to Ansys Prime Server, which delivers core Ansys meshing technology."
readme = "README.md"
requires-python = ">=3.8,<4"
Expand Down
4 changes: 2 additions & 2 deletions src/ansys/meshing/prime/autogen/automesh.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,9 @@ def mesh(self, part_id : int, automesh_params : AutoMeshParams) -> AutoMeshResul
"""
if not isinstance(part_id, int):
raise TypeError("Invalid argument type passed for part_id, valid argument type is int.")
raise TypeError("Invalid argument type passed for 'part_id'. Valid argument type is int.")
if not isinstance(automesh_params, AutoMeshParams):
raise TypeError("Invalid argument type passed for automesh_params, valid argument type is AutoMeshParams.")
raise TypeError("Invalid argument type passed for 'automesh_params'. Valid argument type is AutoMeshParams.")
args = {"part_id" : part_id,
"automesh_params" : automesh_params._jsonify()}
command_name = "PrimeMesh::AutoMesh/Mesh"
Expand Down
84 changes: 42 additions & 42 deletions src/ansys/meshing/prime/autogen/automeshstructs.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,20 +64,20 @@ def __init__(
error_locations: Iterable[float] = None,
json_data : dict = None,
**kwargs):
"""Initializes the AutoMeshResults.
"""Initialize a ``AutoMeshResults`` object.
Parameters
----------
model: Model
Model to create a AutoMeshResults object with default parameters.
Model to create a ``AutoMeshResults`` object with default parameters.
error_code: ErrorCode, optional
Provides error message when automesh fails.
warning_codes: List[WarningCode], optional
Warning codes associated with the operation.
error_locations: Iterable[float], optional
Error location coordinates returned when automesh fails.
json_data: dict, optional
JSON dictionary to create a AutoMeshResults object with provided parameters.
JSON dictionary to create a ``AutoMeshResults`` object with provided parameters.
Examples
--------
Expand All @@ -97,7 +97,7 @@ def __init__(
error_locations)
else:
if model is None:
raise ValueError("Invalid assignment. Either pass model or specify all properties")
raise ValueError("Invalid assignment. Either pass a model or specify all properties.")
else:
param_json = model._communicator.initialize_params(model, "AutoMeshResults")
json_data = param_json["AutoMeshResults"] if "AutoMeshResults" in param_json else {}
Expand All @@ -117,7 +117,7 @@ def set_default(
error_code: ErrorCode = None,
warning_codes: List[WarningCode] = None,
error_locations: Iterable[float] = None):
"""Set the default values of AutoMeshResults.
"""Set the default values of the ``AutoMeshResults`` object.
Parameters
----------
Expand All @@ -133,7 +133,7 @@ def set_default(

@staticmethod
def print_default():
"""Print the default values of AutoMeshResults.
"""Print the default values of ``AutoMeshResults`` object.
Examples
--------
Expand Down Expand Up @@ -208,18 +208,18 @@ def __init__(
gap_factor_scale: float = None,
json_data : dict = None,
**kwargs):
"""Initializes the PrismStairStep.
"""Initialize a ``PrismStairStep`` object.
Parameters
----------
model: Model
Model to create a PrismStairStep object with default parameters.
Model to create a ``PrismStairStep`` object with default parameters.
check_proximity: bool, optional
Check whether to enable or disable stairstepping at prisms within proximity of boundary or prism cap.
gap_factor_scale: float, optional
Scale factor for prism proximity detection gap factor.
json_data: dict, optional
JSON dictionary to create a PrismStairStep object with provided parameters.
JSON dictionary to create a ``PrismStairStep`` object with provided parameters.
Examples
--------
Expand All @@ -237,7 +237,7 @@ def __init__(
gap_factor_scale)
else:
if model is None:
raise ValueError("Invalid assignment. Either pass model or specify all properties")
raise ValueError("Invalid assignment. Either pass a model or specify all properties.")
else:
param_json = model._communicator.initialize_params(model, "PrismStairStep")
json_data = param_json["PrismStairStep"] if "PrismStairStep" in param_json else {}
Expand All @@ -255,7 +255,7 @@ def __init__(
def set_default(
check_proximity: bool = None,
gap_factor_scale: float = None):
"""Set the default values of PrismStairStep.
"""Set the default values of the ``PrismStairStep`` object.
Parameters
----------
Expand All @@ -269,7 +269,7 @@ def set_default(

@staticmethod
def print_default():
"""Print the default values of PrismStairStep.
"""Print the default values of ``PrismStairStep`` object.
Examples
--------
Expand Down Expand Up @@ -332,18 +332,18 @@ def __init__(
no_imprint_zonelets: Iterable[int] = None,
json_data : dict = None,
**kwargs):
"""Initializes the PrismParams.
"""Initialize a ``PrismParams`` object.
Parameters
----------
model: Model
Model to create a PrismParams object with default parameters.
Model to create a ``PrismParams`` object with default parameters.
stair_step: PrismStairStep, optional
Prism stairstep parameters.
no_imprint_zonelets: Iterable[int], optional
Option to specify zonelets to skip prism imprint.
json_data: dict, optional
JSON dictionary to create a PrismParams object with provided parameters.
JSON dictionary to create a ``PrismParams`` object with provided parameters.
Examples
--------
Expand All @@ -361,7 +361,7 @@ def __init__(
no_imprint_zonelets)
else:
if model is None:
raise ValueError("Invalid assignment. Either pass model or specify all properties")
raise ValueError("Invalid assignment. Either pass a model or specify all properties.")
else:
param_json = model._communicator.initialize_params(model, "PrismParams")
json_data = param_json["PrismParams"] if "PrismParams" in param_json else {}
Expand All @@ -379,7 +379,7 @@ def __init__(
def set_default(
stair_step: PrismStairStep = None,
no_imprint_zonelets: Iterable[int] = None):
"""Set the default values of PrismParams.
"""Set the default values of the ``PrismParams`` object.
Parameters
----------
Expand All @@ -393,7 +393,7 @@ def set_default(

@staticmethod
def print_default():
"""Print the default values of PrismParams.
"""Print the default values of ``PrismParams`` object.
Examples
--------
Expand Down Expand Up @@ -459,20 +459,20 @@ def __init__(
size_range_max: float = None,
json_data : dict = None,
**kwargs):
"""Initializes the SurfaceMeshSizeScaling.
"""Initialize a ``SurfaceMeshSizeScaling`` object.
Parameters
----------
model: Model
Model to create a SurfaceMeshSizeScaling object with default parameters.
Model to create a ``SurfaceMeshSizeScaling`` object with default parameters.
factor: float, optional
Value by which size should be multiplied when the size falls within a certain range. Applicable only when sizeFieldType is set to Geometric in AutoMeshParams structure.
size_range_min: float, optional
Minimum size required to apply scaling. Applicable only when sizeFieldType is set to Geometric in AutoMeshParams structure.
size_range_max: float, optional
Maximum size required to apply scaling. Applicable only when sizeFieldType is set to Geometric in AutoMeshParams structure.
json_data: dict, optional
JSON dictionary to create a SurfaceMeshSizeScaling object with provided parameters.
JSON dictionary to create a ``SurfaceMeshSizeScaling`` object with provided parameters.
Examples
--------
Expand All @@ -492,7 +492,7 @@ def __init__(
size_range_max)
else:
if model is None:
raise ValueError("Invalid assignment. Either pass model or specify all properties")
raise ValueError("Invalid assignment. Either pass a model or specify all properties.")
else:
param_json = model._communicator.initialize_params(model, "SurfaceMeshSizeScaling")
json_data = param_json["SurfaceMeshSizeScaling"] if "SurfaceMeshSizeScaling" in param_json else {}
Expand All @@ -512,7 +512,7 @@ def set_default(
factor: float = None,
size_range_min: float = None,
size_range_max: float = None):
"""Set the default values of SurfaceMeshSizeScaling.
"""Set the default values of the ``SurfaceMeshSizeScaling`` object.
Parameters
----------
Expand All @@ -528,7 +528,7 @@ def set_default(

@staticmethod
def print_default():
"""Print the default values of SurfaceMeshSizeScaling.
"""Print the default values of ``SurfaceMeshSizeScaling`` object.
Examples
--------
Expand Down Expand Up @@ -618,12 +618,12 @@ def __init__(
enable_region_based_hexcore: bool = None,
json_data : dict = None,
**kwargs):
"""Initializes the HexCoreParams.
"""Initialize a ``HexCoreParams`` object.
Parameters
----------
model: Model
Model to create a HexCoreParams object with default parameters.
Model to create a ``HexCoreParams`` object with default parameters.
transition_size_field_type: SizeFieldType, optional
Size field type to be used for transition volume (volume between hexcore and boundary).
buffer_layers: int, optional
Expand All @@ -639,7 +639,7 @@ def __init__(
enable_region_based_hexcore: bool, optional
Checks whether to enable region based hexcore or not.
json_data: dict, optional
JSON dictionary to create a HexCoreParams object with provided parameters.
JSON dictionary to create a ``HexCoreParams`` object with provided parameters.
Examples
--------
Expand Down Expand Up @@ -667,7 +667,7 @@ def __init__(
enable_region_based_hexcore)
else:
if model is None:
raise ValueError("Invalid assignment. Either pass model or specify all properties")
raise ValueError("Invalid assignment. Either pass a model or specify all properties.")
else:
param_json = model._communicator.initialize_params(model, "HexCoreParams")
json_data = param_json["HexCoreParams"] if "HexCoreParams" in param_json else {}
Expand Down Expand Up @@ -695,7 +695,7 @@ def set_default(
cell_element_type: HexCoreCellElementType = None,
surface_mesh_size_scaling: SurfaceMeshSizeScaling = None,
enable_region_based_hexcore: bool = None):
"""Set the default values of HexCoreParams.
"""Set the default values of the ``HexCoreParams`` object.
Parameters
----------
Expand All @@ -719,7 +719,7 @@ def set_default(

@staticmethod
def print_default():
"""Print the default values of HexCoreParams.
"""Print the default values of ``HexCoreParams`` object.
Examples
--------
Expand Down Expand Up @@ -839,16 +839,16 @@ def __init__(
quadratic: bool = None,
json_data : dict = None,
**kwargs):
"""Initializes the TetParams.
"""Initialize a ``TetParams`` object.
Parameters
----------
model: Model
Model to create a TetParams object with default parameters.
Model to create a ``TetParams`` object with default parameters.
quadratic: bool, optional
Option to generate quadratic tetrahedral mesh. It is not supported with parallel meshing. It is only supported with pure tetrahedral mesh.
json_data: dict, optional
JSON dictionary to create a TetParams object with provided parameters.
JSON dictionary to create a ``TetParams`` object with provided parameters.
Examples
--------
Expand All @@ -864,7 +864,7 @@ def __init__(
quadratic)
else:
if model is None:
raise ValueError("Invalid assignment. Either pass model or specify all properties")
raise ValueError("Invalid assignment. Either pass a model or specify all properties.")
else:
param_json = model._communicator.initialize_params(model, "TetParams")
json_data = param_json["TetParams"] if "TetParams" in param_json else {}
Expand All @@ -880,7 +880,7 @@ def __init__(
@staticmethod
def set_default(
quadratic: bool = None):
"""Set the default values of TetParams.
"""Set the default values of the ``TetParams`` object.
Parameters
----------
Expand All @@ -892,7 +892,7 @@ def set_default(

@staticmethod
def print_default():
"""Print the default values of TetParams.
"""Print the default values of ``TetParams`` object.
Examples
--------
Expand Down Expand Up @@ -970,12 +970,12 @@ def __init__(
periodic_control_ids: Iterable[int] = None,
json_data : dict = None,
**kwargs):
"""Initializes the AutoMeshParams.
"""Initialize a ``AutoMeshParams`` object.
Parameters
----------
model: Model
Model to create a AutoMeshParams object with default parameters.
Model to create a ``AutoMeshParams`` object with default parameters.
size_field_type: SizeFieldType, optional
Type of sizing to be used to generate volume mesh.
max_size: float, optional
Expand All @@ -999,7 +999,7 @@ def __init__(
periodic_control_ids: Iterable[int], optional
Ids of the periodic controls.
json_data: dict, optional
JSON dictionary to create a AutoMeshParams object with provided parameters.
JSON dictionary to create a ``AutoMeshParams`` object with provided parameters.
Examples
--------
Expand Down Expand Up @@ -1035,7 +1035,7 @@ def __init__(
periodic_control_ids)
else:
if model is None:
raise ValueError("Invalid assignment. Either pass model or specify all properties")
raise ValueError("Invalid assignment. Either pass a model or specify all properties.")
else:
param_json = model._communicator.initialize_params(model, "AutoMeshParams")
json_data = param_json["AutoMeshParams"] if "AutoMeshParams" in param_json else {}
Expand Down Expand Up @@ -1071,7 +1071,7 @@ def set_default(
hexcore: HexCoreParams = None,
volume_control_ids: Iterable[int] = None,
periodic_control_ids: Iterable[int] = None):
"""Set the default values of AutoMeshParams.
"""Set the default values of the ``AutoMeshParams`` object.
Parameters
----------
Expand Down Expand Up @@ -1103,7 +1103,7 @@ def set_default(

@staticmethod
def print_default():
"""Print the default values of AutoMeshParams.
"""Print the default values of ``AutoMeshParams`` object.
Examples
--------
Expand Down
Loading

0 comments on commit a969b86

Please sign in to comment.