Body

class ansys.speos.core.body.Body(speos_client, name, description='', metadata=None, parent_part=None)

Feature : Body.

Parameters:

speos_clientansys.speos.core.kernel.client.SpeosClient

The Speos instance client.

namestr

Name of the feature.

descriptionstr

Description of the feature. By default, "".

metadataMapping[str, str]

Metadata of the feature. By default, {}.

parent_partUnion[ansys.speos.core.part.Part, ansys.speos.core.part.Part.SubPart], optional

Feature containing this sub part. By default, None.

Attributes:

body_linkansys.speos.core.kernel.body.BodyLink

Link object for the body in database.

Parameters:

• speos_client (ansys.speos.core.kernel.client.SpeosClient)

• name (str)

• description (str)

• metadata (Optional[Mapping[str, str]])

• parent_part (Optional[Union[ansys.speos.core.part.Part, ansys.speos.core.part.Part.SubPart]])

Overview

Methods

create_face	Create a face in this element.
commit	Save feature: send the local data to the speos server database.
reset	Reset feature: override local data by the one from the speos server database.
delete	Delete feature: delete data from the speos server database.
find	Find feature(s). In a body, only faces features can be found.

Attributes

body_link

Link object for the body in database.

Special methods

__str__

Return the string representation of the body.

Import detail

from ansys.speos.core.body import Body

Attribute detail

Body.body_link = None

Link object for the body in database.

Method detail

Body.create_face(name, description='', metadata=None)

Create a face in this element.

Parameters:

namestr

Name of the feature.

descriptionstr

Description of the feature. By default, "".

metadataOptional[Mapping[str, str]]

Metadata of the feature. By default, {}.

Returns:

ansys.speos.core.face.Face

Face feature.

Body.__str__()

Return the string representation of the body.

Body.commit()

Save feature: send the local data to the speos server database.

Returns:

ansys.speos.core.body.Body

Body feature.

Body.reset()

Reset feature: override local data by the one from the speos server database.

Returns:

ansys.speos.core.body.Body

Body feature.

Body.delete()

Delete feature: delete data from the speos server database.

Returns:

ansys.speos.core.body.Body

Body feature.

Body.find(name, name_regex=False, feature_type=None)

Find feature(s). In a body, only faces features can be found.

Parameters:

namestr

Name of the feature. Example “FaceName”

name_regexbool

Allows to use regex for name parameter. By default, False, means that regex is not used for name parameter.

feature_typetype

Type of the wanted feature (example: ansys.speos.core.face.Face). By default, None, means that all features will be considered.

Returns:

List[ansys.speos.core.face.Face]

Found features.