Prime Mesh Python client library 2025 R2 SP04

Model

Last update: 20.02.2026

class ansys.meshing.prime.Model(comm, id, object_id, name)

Model is the nucleus of Prime. Model forms the base and contains all the information about Prime.

You can access any information in Prime only through Model. Model allows you to query TopoData, ControlData, Parts, SizeFields and more.

  • Parameters:

    comm : Communicator to connect with the Ansys Prime server.

    id : Id of the Model.

    object_id : Object id of the Model.

    name : Name of the Model.

Methods

Name Description
Model.activate_volumetric_size_fields(...) Activate the sizefields identified by the given sizefield ids.
Model.as_polydata([update]) Get the model as a polydata.
Model.create_zone(suggested_name, type) Creates zone for the given zone type.
Model.deactivate_volumetric_size_fields(...) Deactivate the size fields with the given size field ids.
Model.delete_parts(part_ids) Delete parts and their contents.
Model.delete_volumetric_size_fields(...) Delete the sizefields identified by the given sizefield ids.
Model.delete_zone(zone_id) Deletes zone with the given id.
Model.get_active_volumetric_size_fields() Get the active sizefield ids.
Model.get_global_sizing_params() Get global sizing parameters.
Model.get_num_compute_nodes() Get the number of compute nodes.
Model.get_num_threads() Get the number of threads enabled for multithreaded operation.
Model.get_part(id) Get the part by ID.
Model.get_part_by_name(name) Get the part by name.
Model.get_scoped_polydata(scope[, update]) Get the scoped polydata of the model.
Model.get_size_field_name(size_field_id) Gets the name of size field with the given id.
Model.get_volumetric_size_fields() Get the sizefield ids.
Model.get_zone_by_name(zone_name) Gets the zone with the provided name.
Model.get_zone_name(id) Get the name of given zone.
Model.merge_parts(part_ids, params) Merge multiple parts into a single part.
Model.set_global_sizing_params(params) Set global sizing parameters.
Model.set_num_threads(num) Sets the number of threads for multithreaded operation.
Model.set_suggested_size_field_name(...) Sets the suggested name of size field with the given id.
Model.set_suggested_zone_name(id, name) Sets the unique name for zone with given id based on the suggested name.
Model.set_working_directory(path) Set working directory.
Model.start_distributed_meshing() Enables distributed meshing mode.

Attributes

Name Description
Model.control_data Get the control data for the model.
Model.id Get the id of Model.
Model.logger Get PyPrimeMesh's logger instance.
Model.material_point_data Get material point data for the model.
Model.name Get the name of Model.
Model.parts Get the list of parts for the model.
Model.python_logger Get python standard logger from PyPrimeMesh's logger instance.
Model.topo_data Get the TopoData for the model.

Connect with Ansys