haiiliin / abqpy / 5910646359

    ALL_NODAL_DIAMETER,

    ALLOW_SUBCYCLING,

    AMBIENT,

    BLOCKING_ALL,

    COMPUTED,

    COMPUTED_TOLERANCE,

    CONTACT,

    DEFAULT,

    GEOMETRY,

    KINEMATIC,

    LAGRANGIAN,

    MODEL,

    NONE,

    OFF,

    OMIT,

    ON,

    PLANE,

    PRESSURE,

    SURFACE_TO_SURFACE,

    TABULAR,

    TO_ENVIRONMENT,

    UNIFORM,

    UNSET,

    USE_GEOMETRY,

    Boolean,

)

    InteractionContactControlModel,

    InteractionContactInitializationModel,

    InteractionContactStabilizationModel,

    InteractionPropertyModel,

):

    """Abaqus creates a Model object named `Model-1` when a session is started.

    .. note::

        This object can be accessed by::

            mdb.models[name]

    """

        self,

        name: str = "",

        createStepName: str = "",

        searchDomain: Literal[C.MODEL] = MODEL,

        defaultType: Literal[C.CONTACT, C.CONTACT_EXPLICIT, C.TIE, C.CONTACT_STANDARD] = CONTACT,

        interactionProperty: str = "",

        separationTolerance: float | None = None,

        extendByAngle: float = 20,

        mergeWithinAngle: float = 20,

        searchSingleInstances: Boolean = OFF,

        nameEachSurfaceFound: Boolean = ON,

        createUnionOfMasterSurfaces: Boolean = OFF,

        createUnionOfSlaveSurfaces: Boolean = OFF,

        createUnionOfMasterSlaveSurfaces: Boolean = OFF,

        includePlanar: Boolean = ON,

        includeCylindricalSphericalToric: Boolean = ON,

        includeSplineBased: Boolean = ON,

        includeMeshSolid: Boolean = ON,

        includeMeshShell: Boolean = ON,

        includeMeshMembrane: Boolean = OFF,

        includeOverclosed: Boolean = ON,

        includeNonOverlapping: Boolean = OFF,

        meshedGeometrySearchTechnique: Literal[C.USE_MESH, C.USE_GEOMETRY] = USE_GEOMETRY,

        useShellThickness: Boolean = ON,

        surfaceSmoothing: Literal[C.AUTOMATIC, C.NONE] | None = None,

    ):

        """This method uses contact detection to create SurfaceToSurfaceContactStd, SurfaceToSurfaceContactExp,

        and Tie objects.

        Parameters

        ----------

        name

            A String specifying the prefix used to generate repository keys. The default value is

            "CP-"

        createStepName

            A String specifying the name of the step in which the SurfaceToSurfaceContactStd,

            SurfaceToSurfaceContactExp, and Tie objects are created. The default value is "Initial."

        searchDomain

            A SymbolicConstant MODEL or a sequence of Strings specifying the names of instances to

            search. MODEL indicates the whole model is searched. The default value is MODEL.

        defaultType

            A SymbolicConstant specifying the default type of object to create. Possible values are

            CONTACT, CONTACT_STANDARD, CONTACT_EXPLICIT, and TIE. If CONTACT is used, the behavior

            is determined by the type of Step in the model. If an ExplicitDynamicsStep or

            TempDisplacementDynamicsStep exists, then SurfaceToSurfaceContactExp is created by

            default. Otherwise SurfaceToSurfaceContactStd is created by default. The default value

            is CONTACT.

        interactionProperty

            A String specifying the name of the ContactProperty object associated with any

            interactions created.

        separationTolerance

            A Float specifying the maximum separation for considering two surfaces to be candidates

            for contact, where separation is the maximum distance between the points of closest

            approach on the two surfaces. The default value is a function of the model.

        extendByAngle

            None or a Float specifying the angle for extending surface definitions to include

            adjacent faces. The default value is 20.

        mergeWithinAngle

            None or a Float specifying the angle for merging adjacent contact pairs that lie within

            the angle. The default value is 20.

        searchSingleInstances

            A Boolean specifying whether to include surface pairs within a single instance. The

            default value is OFF.

        nameEachSurfaceFound

            A Boolean specifying whether to assign a name to each surface found. The default value

            is ON.

        createUnionOfMasterSurfaces

            A Boolean specifying whether to create a surface that is the union of all master surfaces

            found. The default value is OFF.

        createUnionOfSlaveSurfaces

            A Boolean specifying whether to create a surface that is the union of all slave

            surfaces found. The default value is OFF.

        createUnionOfMasterSlaveSurfaces

            A Boolean specifying whether to create a surface that is the union of all master and

            slave surfaces found. The default value is OFF.

        includePlanar

            A Boolean specifying whether to include planar geometry. The default value is ON.

        includeCylindricalSphericalToric

            A Boolean specifying whether to include cylindrical, spherical, and toric geometry. The

            default value is ON.

        includeSplineBased

            A Boolean specifying whether to include spline-based geometry. The default value is ON.

        includeMeshSolid

            A Boolean specifying whether to include solid mesh entities. The default value is ON.

        includeMeshShell

            A Boolean specifying whether to include shell mesh entities. The default value is ON.

        includeMeshMembrane

            A Boolean specifying whether to include mesh membrane entities. The default value is

            OFF.

        includeOverclosed

            A Boolean specifying whether to include overclosed pairs. The default value is ON.

        includeNonOverlapping

            A Boolean specifying whether to include opposing geometry surfaces that do not overlap.

            The default value is OFF.

        meshedGeometrySearchTechnique

            A SymbolicConstant USE_GEOMETRY or USE_MESH specifying whether to locate pairs in meshed

            geometry using the geometric entities or mesh entities. The default value is

            USE_GEOMETRY.

        useShellThickness

            A Boolean specifying whether to account for shell thickness and offset during contact

            detection. The default value is ON.

        surfaceSmoothing

            A SymbolicConstant specifying whether to use surface smoothing for geometric surfaces in

            SurfaceToSurfaceContactStd interactions. Possible values are NONE and AUTOMATIC. The

            default value isAUTOMATIC.

        Returns

        -------

        None.

        """

        """This method returns a list of all possible contacts that can be created using the ContactDetection

        method.

        Returns

        -------

        tuple[tuple[str, str, float, bool]]

            Tuple of tuples, where each tuple holds information, to be used in contact creation as

            follows:

            - A string specifying the name of the master surface used in contact.

            - A string specifying the name of the slave surface used in contact.

            - A float specifying the separation distance between the master surface and the slave

              surface.

            - A boolean specifying whether or not contact surfaces are overclosed.

        """

        self,

        name: str,

        createStepName: str,

        surface: Region,

        definition: Literal[C.TABULAR, C.NONREFLECTING] = TABULAR,

        interactionProperty: str = "",

        nonreflectingType: Literal[

            C.PLANE, C.ELLIPTICAL, C.IMPROVED, C.SPHERICAL, C.PROLATE, C.CIRCULAR, C.NONREFLECTING

        ] = PLANE,

        radius: float = 1,

        semimajorAxis: float = 1,

        eccentricity: float = 0,

        centerCoordinates: tuple = (),

        directionCosine: tuple = (),

    ) -> AcousticImpedance:

        """This method creates an AcousticImpedance object.

        .. note::

            This function can be accessed by::

                mdb.models[name].AcousticImpedance

        Parameters

        ----------

        name

            A String specifying the repository key.

        createStepName

            A String specifying the name of the step in which the AcousticImpedance object is

            created.

        surface

            A Region object specifying the acoustic boundary surface.

        definition

            A SymbolicConstant specifying the type of acoustic impedance to be defined. Possible

            values are TABULAR and NONREFLECTING. The default value is TABULAR.

        interactionProperty

            A String specifying the AcousticImpedanceProp object associated with this interaction.

        nonreflectingType

            A SymbolicConstant specifying the type of nonreflecting geometry to be defined. Possible

            values are PLANE, IMPROVED, CIRCULAR, SPHERICAL, ELLIPTICAL, and PROLATE. The default

            value is PLANE.This argument is valid only when **definition** = NONREFLECTING.

        radius

            A Float specifying the radius of the circle or sphere defining the boundary surface. The

            default value is 1.0.This argument is valid only when **definition** = NONREFLECTING, and

            **nonreflectingType** = CIRCULAR or SPHERICAL.

        semimajorAxis

            A Float specifying the semimajor axis length of the ellipse or prolate spheroid defining

            the boundary surface. The default value is 1.0.This argument is valid only when

            **definition** = NONREFLECTING, and **nonreflectingType** = ELLIPTICAL or PROLATE.

        eccentricity

            A Float specifying the eccentricity of the ellipse or prolate spheroid defining the

            boundary surface. The default value is 0.0.This argument is valid only when

            **definition** = NONREFLECTING, and **nonreflectingType** = ELLIPTICAL or PROLATE.

        centerCoordinates

            A sequence of three Floats specifying the X, Y, and Z coordinates of the center of the

            ellipse or prolate spheroid defining the boundary surface. The default value is (0, 0,

            0).This argument is valid only when **definition** = NONREFLECTING, and

            **nonreflectingType** = ELLIPTICAL or PROLATE.

        directionCosine

            A sequence of three Floats specifying the X, Y, and Z components of the direction cosine

            of the major axis of the ellipse or prolate spheroid defining the boundary surface. The

            default value is (0, 0, 1).This argument is valid only when **definition** = NONREFLECTING,

            and **nonreflectingType** = ELLIPTICAL or PROLATE.

        Returns

        -------

        AcousticImpedance

            An AcousticImpedance object.

        """

            name,

            createStepName,

            surface,

            definition,

            interactionProperty,

            nonreflectingType,

            radius,

            semimajorAxis,

            eccentricity,

            centerCoordinates,

            directionCosine,

        )

        self,

        name: str,

        createStepName: str,

        point: Region,

        interactionProperty: str,

        noCoordComponents: int,

        unsymm: Boolean,

        noSolutionDepVar: int,

        userSubUel: str,

        dof: str,

        solutionDepVars: tuple,

    ) -> ActuatorSensor:

        """This method creates an ActuatorSensor object.

        .. note::

            This function can be accessed by::

                mdb.models[name].ActuatorSensor

        Parameters

        ----------

        name

            A String specifying the repository key.

        createStepName

            A String specifying the name of the step in which the actuator/sensor interaction is

            created. **createStepName** must be set to 'Initial'.

        point

            A Region object specifying the point at which the constraint is applied.

        interactionProperty

            A String specifying the ActuatorSensorProp object associated with this interaction.

        noCoordComponents

            An Int specifying the number of coordinate components supplied to the user subroutine

            (UEL).

        unsymm

            A Boolean specifying whether the element matrices are symmetric (ON) or unsymmetric

            (OFF). The default value is OFF.

        noSolutionDepVar

            An Int specifying the number of solution-dependent variables. The default value is 0.

        userSubUel

            A String specifying the name of the user subroutine (UEL) that defines the user element.

        dof

            A String specifying the degrees of freedom, separated by commas.

        solutionDepVars

            A sequence of Floats specifying the initial values of the solution-dependent variables.

        Returns

        -------

        ActuatorSensor

            An ActuatorSensor object.

        """

            name,

            createStepName,

            point,

            interactionProperty,

            noCoordComponents,

            unsymm,

            noSolutionDepVar,

            userSubUel,

            dof,

            solutionDepVars,

        )

        self,

        name: str,

        createStepName: str,

        surfaces: RegionArray,

        surfaceEmissivities: tuple = (),

        ambientTemp: float | None = None,

        blocking: Literal[C.NO_BLOCKING, C.BLOCKING_ALL, C.PARTIAL_BLOCKING] = BLOCKING_ALL,

        blockingSurfaces: RegionArray | None = None,

        rangeOfView: float | None = None,

        surfaceReflection: Boolean = ON,

        viewfactorAccurTol: float = 0,

        minInfinitesimalRatio: float = 64,

        numPointsPerEdge: int = 3,

        minLumpedAreaDS: float = 5,

        cyclicSymmetry: Boolean = OFF,

        cyclicImages: int = 2,

        cyclicRotPt: ModelDot | None = None,

        cyclicRotEndPt: ModelDot | None = None,

        cyclicSymPt: ModelDot | None = None,

        periodicSymmetries: int = 0,

        periodicImages_1: int = 2,

        periodicImages_2: int = 2,

        periodicImages_3: int = 2,

        periodicSymAxis_1: str = "",

        periodicSymAxis_2: str = "",

        periodicSymPlane_1: str = "",

        periodicSymPlane_2: str = "",

        periodicSymPlane_3: str = "",

        periodicDistance_1: tuple = (),

        periodicDistance_2: tuple = (),

        periodicDistance_3: tuple = (),

        periodicSymZ: float | None = None,

        periodicDistZ: float | None = None,

        reflectionSymmetries: int = 0,

        reflectionSymAxis_1: str = "",

        reflectionSymAxis_2: str = "",

        reflectionSymPlane_1: str = "",

        reflectionSymPlane_2: str = "",

        reflectionSymPlane_3: str = "",

        reflectionSymZ: float | None = None,

    ) -> CavityRadiation:

        """This method creates a CavityRadiation object.

        .. note::

            This function can be accessed by::

                mdb.models[name].CavityRadiation

        Parameters

        ----------

        name

            A String specifying the repository key.

        createStepName

            A String specifying the name of the step in which the cavity radiation interaction

            should be created.

        surfaces

            A RegionArray object specifying the surfaces for which radiation viewfactor control is

            being specified.

        surfaceEmissivities

            A sequence of Strings specifying the names of the Cavity Radiation properties containing

            the surface emissivity data. One name per specified surface. The emissivity data is

            ignored when **surfaceReflection** = OFF.

        ambientTemp

            None or a Float specifying the reference ambient temperature value, θ0θ0. Specifying a

            value indicates an open cavity. The default value is None.

        blocking

            A SymbolicConstant specifying the blocking checks to be performed in the viewfactor

            calculations. Possible values are BLOCKING_ALL, NO_BLOCKING, and PARTIAL_BLOCKING. The

            default value is BLOCKING_ALL.

        blockingSurfaces

            A RegionArray object specifying the surfaces that provide blocking inside the cavity.

            This argument applies only when **blocking** = PARTIAL_BLOCKING.

        rangeOfView

            None or a Float specifying the maximum distance between surface facets at which

            viewfactors are calculated. More distant facets are deemed too far apart to exchange

            significant amounts of heat through radiation effects, and the viewfactors between these

            facets are assumed to be zero. If **rangeOfView** = None, there is no upper limit. The

            default value is None.

        surfaceReflection

            A Boolean specifying whether heat reflections are to be included in the cavity radiation

            calculations. The default value is ON.

        viewfactorAccurTol

            A Float specifying the acceptable tolerance for the viewfactor calculations. The default

            value is 0.05.

        minInfinitesimalRatio

            A Float specifying the facet area ratio above which the infinitesimal-to-finite area

            approximation is used for viewfactor calculations. The default value is 64.0.

        numPointsPerEdge

            An Int specifying the number of Gauss integration points to be used along each edge when

            the numerical integration of contour integrals is used for viewfactor calculations. One

            to five integration points are allowed. The default value is 3.

        minLumpedAreaDS

            A Float specifying the nondimensional distance-square value above which the lumped area

            approximation is used for viewfactor calculations. The default value is 5.0.

        cyclicSymmetry

            A Boolean specifying whether cyclic symmetry will be applied. This argument cannot be

            specified for axisymmetric models. The default value is OFF.

        cyclicImages

            An Int specifying the number of cyclically similar images that compose the cavity formed

            as a result of this symmetry. This argument applies only when **cyclicSymmetry** = ON. The

            default value is 2.

        cyclicRotPt

            A ModelDot object specifying the rotation axis point. This argument applies only when

            **cyclicSymmetry** = ON.

        cyclicRotEndPt

            A ModelDot object specifying the rotation axis end point. This argument applies only for

            three-dimensional models, and only when **cyclicSymmetry** = ON.

        cyclicSymPt

            A ModelDot object specifying the symmetry axis end point. This argument applies only

            when **cyclicSymmetry** = ON.

        periodicSymmetries

            An Int specifying the number of periodic symmetries that will be applied. The default

            value is 0.

        periodicImages_1

            An Int specifying the number of repetitions used in the numerical calculation of the

            cavity viewfactors resulting from the first periodic symmetry. The result of this

            symmetry is a cavity composed of the cavity surface defined in the model plus twice the

            value of **periodicImages_1**. This argument applies only when **periodicSymmetries** is

            greater than zero. The default value is 2.

        periodicImages_2

            An Int specifying the number of repetitions used in the numerical calculation of the

            cavity viewfactors resulting from the second periodic symmetry. The result of this

            symmetry is a cavity composed of the cavity surface defined in the model plus twice the

            value of **periodicImages_2**. This argument applies only when **periodicSymmetries** is

            greater than one. The default value is 2.

        periodicImages_3

            An Int specifying the number of repetitions used in the numerical calculation of the

            cavity viewfactors resulting from the third periodic symmetry. The result of this

            symmetry is a cavity composed of the cavity surface defined in the model plus twice the

            value of **periodicImages_3**. This argument applies only when **periodicSymmetries** = 3.

            The default value is 2.

        periodicSymAxis_1

            A straight Edge, a Datum object representing a datum axis, or an ElementEdge object

            indicating the first line of symmetry in two-dimensional models. This argument applies

            only for 2D models, and when **periodicSymmetries** is greater than zero.

        periodicSymAxis_2

            A straight Edge, a Datum object representing a datum axis, or an ElementEdge object

            indicating the second line of symmetry in two-dimensional models. This argument applies

            only for two-dimensional models, and when **periodicSymmetries** = 2.

        periodicSymPlane_1

            A planar Face, an ElementFace, or a Datum object representing a datum plane; indicating

            the first plane of symmetry in three-dimensional models. This argument applies only for

            three-dimensional models, and when **periodicSymmetries** is greater than zero.

        periodicSymPlane_2

            A planar Face, an ElementFace, or a Datum object representing a datum plane; indicating

            the second plane of symmetry in three-dimensional models. This argument applies only for

            three-dimensional models, and when **periodicSymmetries** is greater than one.

        periodicSymPlane_3

            A planar Face, an ElementFace, or a Datum object representing a datum plane; indicating

            the third plane of symmetry in three-dimensional models. This argument applies only for

            three-dimensional models, and when **periodicSymmetries** = 3.

        periodicDistance_1

            A sequence of sequences of Floats specifying the two points of the vector that describes

            the periodic distance for the first periodic symmetry. Each point is defined by a tuple

            of three coordinates indicating its position. This argument applies only when

            **periodicSymmetries** is greater than zero. The default value is an empty sequence.

        periodicDistance_2

            A sequence of sequences of Floats specifying the two points of the vector that describes

            the periodic distance for the second periodic symmetry. Each point is defined by a tuple

            of three coordinates indicating its position. This argument applies only when

            **periodicSymmetries** is greater than one. The default value is an empty sequence.

        periodicDistance_3

            A sequence of sequences of Floats specifying the two points of the vector that describes

            the periodic distance for the third periodic symmetry. Each point is defined by a tuple

            of three coordinates indicating its position. This argument applies only when

            **periodicSymmetries** = 3. The default value is an empty sequence.

        periodicSymZ

            None or a Float specifying the Z value indicating the symmetry reference line in

            axisymmetric models. This argument applies only for axisymmetric models, and when

            **periodicSymmetries** = 1. The default value is None.

        periodicDistZ

            None or a Float specifying the Z value indicating the periodic distance in axisymmetric

            models. This argument applies only for axisymmetric models, and when

            **periodicSymmetries** = 1. The default value is None.

        reflectionSymmetries

            An Int specifying the number of reflection symmetries will be applied. The default value

            is 0.

        reflectionSymAxis_1

            A straight Edge, a Datum object representing a datum axis, or an ElementEdge object

            indicating the first line of symmetry in two-dimensional models. This argument applies

            only for two-dimensional models, and when **reflectionSymmetries** is greater than zero.

        reflectionSymAxis_2

            A straight Edge, a Datum object representing a datum axis, or an ElementEdge object

            indicating the second line of symmetry in two-dimensional models. This argument applies

            only for two-dimensional models, and when **reflectionSymmetries** = 2.

        reflectionSymPlane_1

            A planar Face, an ElementFace, or a Datum object representing a datum plane; indicating

            the first plane of symmetry in three-dimensional models. This argument applies only for

            three-dimensional models, and when **reflectionSymmetries** is greater than zero.

        reflectionSymPlane_2

            A planar Face, an ElementFace, or a Datum object representing a datum plane; indicating

            the second plane of symmetry in three-dimensional models. This argument applies only for

            three-dimensional models, and when **reflectionSymmetries** is greater than one.

        reflectionSymPlane_3

            A planar Face, an ElementFace, or a Datum object representing a datum plane; indicating

            the third plane of symmetry in three-dimensional models. This argument applies only for

            three-dimensional models, and when **reflectionSymmetries** = 3.

        reflectionSymZ

            None or a Float specifying the Z value indicating the symmetry reference line in

            axisymmetric models. This argument applies only for axisymmetric models, and when

            **reflectionSymmetries** = 1. The default value is None.

        Returns

        -------

        CavityRadiation

            A CavityRadiation object.

        """

            name,

            createStepName,

            surfaces,

            surfaceEmissivities,

            ambientTemp,

            blocking,

            blockingSurfaces,

            rangeOfView,

            surfaceReflection,

            viewfactorAccurTol,

            minInfinitesimalRatio,

            numPointsPerEdge,

            minLumpedAreaDS,

            cyclicSymmetry,

            cyclicImages,

            cyclicRotPt,

            cyclicRotEndPt,

            cyclicSymPt,

            periodicSymmetries,

            periodicImages_1,

            periodicImages_2,

            periodicImages_3,

            periodicSymAxis_1,

            periodicSymAxis_2,

            periodicSymPlane_1,

            periodicSymPlane_2,

            periodicSymPlane_3,

            periodicDistance_1,

            periodicDistance_2,

            periodicDistance_3,

            periodicSymZ,

            periodicDistZ,

            reflectionSymmetries,

            reflectionSymAxis_1,

            reflectionSymAxis_2,

            reflectionSymPlane_1,

            reflectionSymPlane_2,

            reflectionSymPlane_3,

            reflectionSymZ,

        )

        self,

        name: str,

        createStepName: str,

        region: Region,

        definition: Literal[C.EMBEDDED_COEFF, C.FIELD, C.USER_SUB, C.PROPERTY_REF],

        nodalArea: float = 1,

        explicitRegionType: Literal[C.LAGRANGIAN, C.SLIDING, C.EULERIAN] = LAGRANGIAN,

        interactionProperty: str = "",

        field: str = "",

        sinkTemperature: float = 0,

        sinkAmplitude: str = "",

        filmCoeff: float = 0,

        filmCoeffAmplitude: str = "",

        sinkFieldName: str = "",

        sinkDistributionType: Literal[C.DISCRETE_FIELD, C.UNIFORM, C.ANALYTICAL_FIELD] = UNIFORM,

    ) -> ConcentratedFilmCondition:

        """This method creates a ConcentratedFilmCondition object.

        .. note::

            This function can be accessed by::

                mdb.models[name].ConcentratedFilmCondition

        Parameters

        ----------

        name

            A String specifying the repository key.

        createStepName

            A String specifying the name of the step in which the ConcentratedFilmCondition object

            is created.

        region

            A Region object specifying the region to which the concentrated film condition

            interaction is applied. The interaction is applied to each node in the region.

        definition

            A SymbolicConstant specifying how the concentrated film condition is defined. Possible

            values are EMBEDDED_COEFF, PROPERTY_REF, USER_SUB, and FIELD.

        nodalArea

            A Float specifying the area associated with the node where the concentrated film

            condition is applied. The default value is 1.0.

        explicitRegionType

            A SymbolicConstant specifying how the concentrated film condition is applied to the

            boundary of an adaptive mesh domain. Possible values are LAGRANGIAN, SLIDING, and

            EULERIAN. The default value is LAGRANGIAN. This argument applies only during an

            Abaqus/Explicit analysis.

        interactionProperty

            A String specifying the name of the FilmConditionProp object associated with this

            interaction. The **interactionProperty** argument applies only when

            **definition** = PROPERTY_REF. The default value is an empty string.

        field

            A String specifying the name of the AnalyticalField object associated with this

            interaction. The **field** argument applies only when **definition** = FIELD. The default

            value is an empty string.

        sinkTemperature

            A Float specifying the reference sink temperature, θ0θ0. The default value is 0.0.

        sinkAmplitude

            A String specifying the name of the Amplitude object that gives the variation of the

            sink temperature, θ0θ0, with time. The default value is an empty string. Note: Use None in

            an Abaqus/Standard analysis to specify that the reference sink temperature is applied

            immediately at the beginning of the step or linearly over the step. Use None in an

            Abaqus/Explicit analysis to specify that the reference sink temperature is applied

            throughout the step.

        filmCoeff

            A Float specifying the reference film coefficient value, hh. The **filmCoeff** argument

            applies when **definition** = EMBEDDED_COEFF, **definition** = USER_SUB, or **definition** = FIELD.

            The default value is 0.0.

        filmCoeffAmplitude

            A String specifying the name of the Amplitude object that gives the variation of the

            film coefficient, hh, with time. The default value is an empty string. Note: Use None in

            an Abaqus/Standard analysis to specify that the reference film coefficient is applied

            immediately at the beginning of the step or linearly over the step. Use None in an

            Abaqus/Explicit analysis to specify that the reference film coefficient is applied

            throughout the step.

        sinkFieldName

            A String specifying the name of the AnalyticalField or DiscreteField object associated

            with the sink temperature. The **sinkFieldName** argument applies only when

            **sinkDistributionType** = ANALYTICAL_FIELD or **sinkDistributionType** = DISCRETE_FIELD. The

            default value is an empty string.

        sinkDistributionType

            A SymbolicConstant specifying how the sink temperature is distributed. Possible values

            are UNIFORM, ANALYTICAL_FIELD, and DISCRETE_FIELD. The default value is UNIFORM.

        Returns

        -------

        ConcentratedFilmCondition

            A ConcentratedFilmCondition object.

        """

            name,

            createStepName,

            region,

            definition,

            nodalArea,

            explicitRegionType,

            interactionProperty,

            field,

            sinkTemperature,

            sinkAmplitude,

            filmCoeff,

            filmCoeffAmplitude,

            sinkFieldName,

            sinkDistributionType,

        )

        self,

        name: str,

        createStepName: str,

        region: Region,

        ambientTemperature: float,

        ambientTemperatureAmp: str,

        emissivity: float,

        nodalArea: float = 1,

        explicitRegionType: Literal[C.LAGRANGIAN, C.SLIDING, C.EULERIAN] = LAGRANGIAN,

        field: str = "",

        distributionType: Literal[C.UNIFORM, C.ANALYTICAL_FIELD] = UNIFORM,

    ) -> ConcentratedRadiationToAmbient:

        """This method creates a ConcentratedRadiationToAmbient object.

        .. note::

            This function can be accessed by::

                mdb.models[name].ConcentratedRadiationToAmbient

        Parameters

        ----------

        name

            A String specifying the repository key.

        createStepName

            A String specifying the name of the step in which the ConcentratedRadiationToAmbient

            object is created.

        region

            A Region object specifying the region to which the concentrated radiation interaction is

            applied. The interaction is applied to each node in the region.

        ambientTemperature

            A Float specifying the reference ambient temperature, θ0θ0.

        ambientTemperatureAmp

            A String specifying the name of the Amplitude object that gives the variation of the

            ambient temperature with time. Note: Use None in an Abaqus/Standard analysis to specify

            that the reference ambient temperature is applied immediately at the beginning of the

            step or linearly over the step. Use None in an Abaqus/Explicit analysis to specify that

            the reference ambient temperature is applied throughout the step.

        emissivity

            A Float specifying the emissivity, ϵϵ.

        nodalArea

            A Float specifying the area associated with the node where the concentrated radiation

            interaction is applied. The default value is 1.0.

        explicitRegionType

            A SymbolicConstant specifying how the concentrated radiation is applied to the boundary

            of an adaptive mesh domain. Possible values are LAGRANGIAN, SLIDING, and EULERIAN. The

            default value is LAGRANGIAN. Note: *explicitRegionType* applies only during an

            Abaqus/Explicit analysis.

        field

            A String specifying the name of the AnalyticalField object associated with this

            interaction. The **field** argument applies only when **distributionType** = ANALYTICAL_FIELD.

            The default value is an empty string.

        distributionType

            A SymbolicConstant specifying how the radiation is defined. Possible values are UNIFORM

            and ANALYTICAL_FIELD. The default value is UNIFORM.

        Returns

        -------

        ConcentratedRadiationToAmbient

            A ConcentratedRadiationToAmbient object.

        """

            name,

            createStepName,

            region,

            ambientTemperature,

            ambientTemperatureAmp,

            emissivity,

            nodalArea,

            explicitRegionType,

            field,

            distributionType,

        )

        self,

        name: str,

        createStepName: str,

        useAllstar: Boolean = OFF,

        globalSmoothing: Boolean = ON,

        includedPairs: RegionPairs | None = None,

        excludedPairs: RegionPairs | None = None,

        contactPropertyAssignments: ContactPropertyAssignment | None = None,

        surfaceThicknessAssignments: SurfaceThicknessAssignment | None = None,

        surfaceOffsetAssignments: SurfaceOffsetAssignment | None = None,

        surfaceFeatureAssignments: SurfaceFeatureAssignment | None = None,

        smoothingAssignments: SmoothingAssignment | None = None,

        masterSlaveAssignments: MasterSlaveAssignment | None = None,

    ):

        """This method creates a ContactExp object.

        .. note::

            This function can be accessed by::

                mdb.models[name].ContactExp

        Parameters

        ----------

        name

            A String specifying the repository key.

        createStepName

            A String specifying the name of the step in which this contact interaction is created.

        useAllstar

            A Boolean specifying whether the contacting surface pair consists of all exterior faces,

            shell edges, beam segments, analytical rigid surfaces, and, when applicable, Eulerian

            material surfaces.

        globalSmoothing

            A Boolean specifying whether surface smoothing (geometric correction) is automatically

            applied to all eligible surfaces. The default value is ON.

        includedPairs

            A RegionPairs object specifying the domain pairs included in contact.

        excludedPairs

            A RegionPairs object specifying the domain pairs excluded from contact.

        contactPropertyAssignments

            A ContactPropertyAssignment object specifying the contact property assignments in the

            contact domain.

        surfaceThicknessAssignments

            A SurfaceThicknessAssignment object specifying the surface thickness assignments in the

            contact domain.

        surfaceOffsetAssignments

            A SurfaceOffsetAssignment object specifying the surface offset fraction assignments in

            the contact domain.

        surfaceFeatureAssignments

            A SurfaceFeatureAssignment object specifying the surface feature angle assignments in

            the contact domain.

        smoothingAssignments

            A SmoothingAssignment object specifying the surface smoothing assignments in the contact

            domain.

        masterSlaveAssignments

            A MasterSlaveAssignment object specifying the master-slave assignments in the

            contact domain.

        Returns

        -------

        ContactExp

            A ContactExp object.

        """

            name,

            createStepName,

            useAllstar,

            globalSmoothing,

            includedPairs,

            excludedPairs,

            contactPropertyAssignments,

            surfaceThicknessAssignments,

            surfaceOffsetAssignments,

            surfaceFeatureAssignments,

            smoothingAssignments,

            masterSlaveAssignments,

        )

        self,

        name: str,

        createStepName: str,

        useAllstar: Boolean = OFF,

        globalSmoothing: Boolean = ON,

        includedPairs: RegionPairs | None = None,

        excludedPairs: RegionPairs | None = None,

        contactPropertyAssignments: ContactPropertyAssignment | None = None,

        surfaceThicknessAssignments: SurfaceThicknessAssignment | None = None,

        surfaceOffsetAssignments: SurfaceOffsetAssignment | None = None,

        surfaceFeatureAssignments: SurfaceFeatureAssignment | None = None,

        masterSlaveAssignments: MasterSlaveAssignment | None = None,

        initializationAssignments: InitializationAssignment | None = None,

        stabilizationAssignments: StabilizationAssignment | None = None,

        smoothingAssignments: SmoothingAssignment | None = None,

        slidingTransitionAssignments: SlidingTransitionAssignment | None = None,

    ) -> ContactStd:

        """This method creates a ContactStd object.

        .. note::

            This function can be accessed by::

                mdb.models[name].ContactStd