haiiliin / abqpy / 29745883762

coverage: 77.656%. First build
29745883762

push

github

web-flow 
Add new classes to support Abaqus 2026 (#6526)

94 of 102 new or added lines in 11 files covered. (92.16%)

25594 of 32958 relevant lines covered (77.66%)

0.78 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

65.52
/src/abaqus/Interaction/InteractionPropertyModel.py
1 
from __future__ import annotations
1✔
2 









3



from typing_extensions import Literal




1✔





4












5



from abqpy.decorators import abaqus_class_doc, abaqus_method_doc




1✔





6












7



from ..Model.ModelBase import ModelBase




1✔





8



from ..UtilityAndView.abaqusConstants import (




1✔





9



    ACOUSTIC,










10



    BULK_VISCOSITY,










11



    HYDRAULIC,










12



    OFF,










13



    ON,










14



    PLANAR,










15



    POLYNOMIAL,










16



    Boolean,










17



)










18



from ..UtilityAndView.abaqusConstants import abaqusConstants as C




1✔





19



from .AcousticImpedanceProp import AcousticImpedanceProp




1✔





20



from .ActuatorSensorProp import ActuatorSensorProp




1✔





21



from .CavityRadiationProp import CavityRadiationProp




1✔





22



from .ContactProperty import ContactProperty




1✔





23



from .FilmConditionProp import FilmConditionProp




1✔





24



from .FluidCavityProperty import FluidCavityProperty




1✔





25



from .FluidExchangeProperty import FluidExchangeProperty




1✔





26



from .FluidInflatorProperty import FluidInflatorProperty




1✔






27



from .GapDiffusivity import GapDiffusivity




1✔





28



from .IncidentWaveProperty import IncidentWaveProperty




1✔





29












30












31



@abaqus_class_doc




1✔





32



class InteractionPropertyModel(ModelBase):




1✔





33



    @abaqus_method_doc




1✔





34



    def AcousticImpedanceProp(




1✔





35



        self,










36



        name: str,










37



        tableType: Literal[C.ADMITTANCE, C.IMPEDANCE],










38



        table: tuple,










39



        frequencyDependency: Boolean = OFF,










40



    ) -> AcousticImpedanceProp:










41



        """This method creates an AcousticImpedanceProp object.










42














43



        .. note::










44



            This function can be accessed by::










45














46



                mdb.models[name].AcousticImpedanceProp










47














48



        Parameters










49



        ----------










50



        name










51



            A String specifying the interaction property repository key.










52



        tableType










53



            A SymbolicConstant specifying the type of tabular data to be defined. Possible values










54



            are IMPEDANCE and ADMITTANCE.










55



        table










56



            A sequence of sequences of Floats specifying acoustic impedance properties.If










57



            **tableType** = IMPEDANCE, each sequence of the table data specifies:The real part of the










58



            complex impedance.The imaginary part of the complex impedance.Frequency, if the data










59



            depend on frequency.If **tableType** = ADMITTANCE, each sequence of the table data










60



            specifies:The real part of the complex admittance.The imaginary part of the complex










61



            admittance.Frequency, if the data depend on frequency.










62



        frequencyDependency










63



            A Boolean specifying whether the **table** data depend on frequency. The default value is










64



            OFF.










65














66



        Returns










67



        -------










68



        AcousticImpedanceProp










69



            An AcousticImpedanceProp object.










70



        """










71



        self.interactionProperties[name] = interactionProperty = AcousticImpedanceProp(




×







72



            name, tableType, table, frequencyDependency










73



        )










74



        return interactionProperty




×







75












76



    @abaqus_method_doc




1✔





77



    def ActuatorSensorProp(




1✔





78



        self, name: str, realProperties: tuple = (), integerProperties: tuple = ()










79



    ) -> ActuatorSensorProp:










80



        """This method creates an ActuatorSensorProp object.










81














82



        .. note::










83



            This function can be accessed by::










84














85



                mdb.models[name].ActuatorSensorProp










86














87



        Parameters










88



        ----------










89



        name










90



            A String specifying the interaction property repository key.










91



        realProperties










92



            A sequence of Floats specifying the PROPS array used by user subroutine UEL. The default










93



            value is an empty sequence.










94



        integerProperties










95



            A sequence of Ints specifying the JPROPS array used by user subroutine UEL. The default










96



            value is an empty sequence.










97














98



        Returns










99



        -------










100



        ActuatorSensorProp










101



            An ActuatorSensorProp object.










102



        """










103



        self.interactionProperties[name] = interactionProperty = ActuatorSensorProp(




×







104



            name, realProperties, integerProperties










105



        )










106



        return interactionProperty




×







107












108



    @abaqus_method_doc




1✔





109



    def CavityRadiationProp(




1✔





110



        self,










111



        name: str,










112



        temperatureDependency: Boolean = OFF,










113



        dependencies: int = 0,










114



        property: tuple = (),










115



    ) -> CavityRadiationProp:










116



        """This method creates a CavityRadiationProp object.










117














118



        .. note::










119



            This function can be accessed by::










120














121



                mdb.models[name].CavityRadiationProp










122














123



        Parameters










124



        ----------










125



        name










126



            A String specifying the interaction property repository key.










127



        temperatureDependency










128



            A Boolean specifying whether the data depend on temperature. The default value is OFF.










129



        dependencies










130



            An Int specifying the number of field variable dependencies. The default value is 0.










131



        property










132



            A sequence of sequences of Floats specifying the following:The emissivity,










133



            ϵϵ.Temperature, if the data depend on temperature.Value of the first field variable, if










134



            the data depend on field variables.Value of the second field variable.Etc.










135














136



        Returns










137



        -------










138



        CavityRadiationProp










139



            A CavityRadiationProp object.










140



        """










141



        self.interactionProperties[name] = interactionProperty = CavityRadiationProp(




×







142



            name, temperatureDependency, dependencies, property










143



        )










144



        return interactionProperty




×







145












146



    @abaqus_method_doc




1✔





147



    def ContactProperty(self, name: str) -> ContactProperty:




1✔





148



        """This method creates a ContactProperty object.










149














150



        .. note::










151



            This function can be accessed by::










152














153



                mdb.models[name].ContactProperty










154














155



        Parameters










156



        ----------










157



        name










158



            A String specifying the interaction property repository key.










159














160



        Returns










161



        -------










162



        ContactProperty










163



            A ContactProperty object.










164



        """










165



        self.interactionProperties[name] = interactionProperty = ContactProperty(name)




×







166



        return interactionProperty




×







167












168



    @abaqus_method_doc




1✔





169



    def FilmConditionProp(




1✔





170



        self,










171



        name: str,










172



        temperatureDependency: Boolean = OFF,










173



        dependencies: int = 0,










174



        property: tuple = (),










175



    ) -> FilmConditionProp:










176



        """This method creates a FilmConditionProp object.










177














178



        .. note::










179



            This function can be accessed by::










180














181



                mdb.models[name].FilmConditionProp










182














183



        Parameters










184



        ----------










185



        name










186



            A String specifying the interaction property repository key.










187



        temperatureDependency










188



            A Boolean specifying whether the data depend on temperature. The default value is OFF.










189



        dependencies










190



            An Int specifying the number of field variable dependencies. The default value is 0.










191



        property










192



            A sequence of sequences of Floats specifying the following:










193














194



            - The film coefficient, hh.










195



            - Temperature, if the data depend on temperature.










196



            - Value of the first field variable, if the data depend on field variables.










197



            - Value of the second field variable.










198



            - Etc.










199














200



        Returns










201



        -------










202



        FilmConditionProp










203



            A FilmConditionProp object.










204



        """










205



        self.interactionProperties[name] = interactionProperty = FilmConditionProp(




×







206



            name, temperatureDependency, dependencies, property










207



        )










208



        return interactionProperty




×







209












210



    @abaqus_method_doc




1✔





211



    def FluidCavityProperty(




1✔





212



        self,










213



        name: str,










214



        definition: Literal[C.PNEUMATIC, C.HYDRAULIC] = HYDRAULIC,










215



        fluidDensity: float | None = None,










216



        molecularWeight: float | None = None,










217



        useExpansion: Boolean = OFF,










218



        expansionTempDep: Boolean = OFF,










219



        expansionDependencies: int = 0,










220



        referenceTemperature: float = 0,










221



        expansionTable: tuple = (),










222



        useBulkModulus: Boolean = OFF,










223



        bulkModulusTempDep: Boolean = OFF,










224



        bulkModulusDependencies: int = 0,










225



        bulkModulusTable: tuple = (),










226



        useCapacity: Boolean = OFF,










227



        capacityType: Literal[C.POLYNOMIAL, C.TABULAR] = POLYNOMIAL,










228



        capacityTempDep: Boolean = OFF,










229



        capacityDependencies: int = 0,










230



        capacityTable: tuple = (),










231



    ) -> FluidCavityProperty:










232



        """This method creates a FluidCavityProperty object.










233














234



        .. note::










235



            This function can be accessed by::










236














237



                mdb.models[name].FluidCavityProperty










238














239



        Parameters










240



        ----------










241



        name










242



            A String specifying the interaction property repository key.










243



        definition










244



            A SymbolicConstant specifying the type of fluid cavity property to be defined. Possible










245



            values are HYDRAULIC and PNEUMATIC. The default value is HYDRAULIC.










246



        fluidDensity










247



            None or a Float specifying the reference fluid density. This argument is applicable only










248



            when **definition** = HYDRAULIC, and is required in that case. The default value is None.










249



        molecularWeight










250



            None or a Float specifying the molecular weight of the ideal gas species. This argument










251



            is applicable only when **definition** = PNEUMATIC, and is required in that case. The










252



            default value is None.










253



        useExpansion










254



            A Boolean specifying whether thermal expansion coefficients will be defined. This










255



            argument is applicable only when **definition** = HYDRAULIC. The default value is OFF.










256



        expansionTempDep










257



            A Boolean specifying whether the thermal fluid expansion data will have temperature










258



            dependency. This argument is applicable only when **definition** = HYDRAULIC and when










259



            **useExpansion** = True. The default value is OFF.










260



        expansionDependencies










261



            An Int specifying the number of field variable dependencies in the thermal fluid










262



            expansion data. This argument is applicable only when **definition** = HYDRAULIC and when










263



            **useExpansion** = True. The default value is 0.










264



        referenceTemperature










265



            A Float specifying the reference temperature for the coefficient of thermal expansion.










266



            This argument is applicable only when **definition** = HYDRAULIC, when **useExpansion** = True,










267



            and when either **expansionTempDep** = True or when **expansionDependencies** is greater than










268



            0. The default value is 0.0.










269



        expansionTable










270



            A sequence of sequences of Floats specifying the thermal expansion coefficients. This










271



            argument is applicable only when **definition** = HYDRAULIC and when **useExpansion** = True.










272



            Each sequence contains the following data:










273














274



            - The mean coefficient of thermal expansion.










275



            - Temperature, if the data depend on temperature.










276



            - Value of the first field variable, if the data depend on field variables.










277



            - Value of the second field variable.










278



            - Etc.










279



        useBulkModulus










280



            A Boolean specifying whether fluid bulk modulus values will be defined. This argument is










281



            applicable only when **definition** = HYDRAULIC. The default value is OFF.










282



        bulkModulusTempDep










283



            A Boolean specifying whether the fluid bulk modulus data will have temperature










284



            dependency. This argument is applicable only when **definition** = HYDRAULIC and when










285



            **useBulkModulus** = True. The default value is OFF.










286



        bulkModulusDependencies










287



            An Int specifying the number of field variable dependencies in the fluid bulk modulus










288



            data. This argument is applicable only when **definition** = HYDRAULIC and when










289



            **useBulkModulus** = True. The default value is 0.










290



        bulkModulusTable










291



            A sequence of sequences of Floats specifying the fluid bulk modulus values. This










292



            argument is applicable only when **definition** = HYDRAULIC and when **useBulkModulus** = True.










293



            Each sequence contains the following data:










294














295



            - The fluid bulk modulus.










296



            - Temperature, if the data depend on temperature.










297



            - Value of the first field variable, if the data depend on field variables.










298



            - Value of the second field variable.










299



            - Etc.










300



        useCapacity










301



            A Boolean specifying whether molar heat capacity values will be defined. This argument










302



            is applicable only when **definition** = PNEUMATIC. The default value is OFF.










303



        capacityType










304



            A SymbolicConstant specifying the method to define the molar heat capacity. Possible










305



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










306



        capacityTempDep










307



            A Boolean specifying whether the molar heat capacity data will have temperature










308



            dependency. This argument is applicable only when **definition** = PNEUMATIC, when










309



            **useCapacity** = True, and when **capacityType** = TABULAR. The default value is OFF.










310



        capacityDependencies










311



            An Int specifying the number of field variable dependencies in the molar heat capacity










312



            data. This argument is applicable only when **definition** = PNEUMATIC, when










313



            **useCapacity** = True, and when **capacityType** = TABULAR. The default value is 0.










314



        capacityTable










315



            A sequence of sequences of Floats specifying the molar heat capacity values in the form










316



            of a polynomial expression. This argument is applicable only when










317



            **definition** = PNEUMATIC, when **useCapacity** = True, and when **capacityType** = POLYNOMIAL. In










318



            this form, only one sequence is specified and that sequence contains the following data:










319














320



            - The first molar heat capacity coefficient.










321



            - The second molar heat capacity coefficient.










322



            - The third molar heat capacity coefficient.










323



            - The fourth molar heat capacity coefficient.










324



            - The fifth molar heat capacity coefficient.










325














326



            Alternatively, the sequence data may specify the molar heat capacity values at constant










327



            pressure for an ideal gas species. This argument is applicable only when










328



            **definition** = PNEUMATIC, when **useCapacity** = True, and when **capacityType** = TABULAR. Each










329



            sequence contains the following data:










330














331



            - The molar heat capacity at constant pressure.










332



            - Temperature, if the data depend on temperature.










333



            - Value of the first field variable, if the data depend on field variables.










334



            - Value of the second field variable.










335



            - Etc.










336














337



        Returns










338



        -------










339



        FluidCavityProperty










340



            A FluidCavityProperty object.










341



        """










342



        self.interactionProperties[name] = interactionProperty = FluidCavityProperty(




×







343



            name,










344



            definition,










345



            fluidDensity,










346



            molecularWeight,










347



            useExpansion,










348



            expansionTempDep,










349



            expansionDependencies,










350



            referenceTemperature,










351



            expansionTable,










352



            useBulkModulus,










353



            bulkModulusTempDep,










354



            bulkModulusDependencies,










355



            bulkModulusTable,










356



            useCapacity,










357



            capacityType,










358



            capacityTempDep,










359



            capacityDependencies,










360



            capacityTable,










361



        )










362



        return interactionProperty




×







363












364



    @abaqus_method_doc




1✔





365



    def FluidExchangeProperty(




1✔





366



        self,










367



        name: str,










368



        dataTable: tuple,










369



        definition: Literal[










370



            C.VOL_FLUX, C.VOL_RATE_LEAK, C.BULK_VISCOSITY, C.MASS_RATE_LEAK, C.MASS_FLUX










371



        ] = BULK_VISCOSITY,










372



        pressureDependency: Boolean = OFF,










373



        temperatureDependency: Boolean = OFF,










374



        fieldDependencies: int = 0,










375



    ) -> FluidExchangeProperty:










376



        """This method creates a FluidExchangeProperty object.










377














378



        .. note::










379



            This function can be accessed by::










380














381



                mdb.models[name].FluidExchangeProperty










382














383



        Parameters










384



        ----------










385



        name










386



            A String specifying the interaction property repository key.










387



        dataTable










388



            A sequence of sequences of Floats specifying the viscous and hydrodynamic resistance










389



            coefficients when **definition** = BULK_VISCOSITY. Each sequence contains the following










390



            data:










391














392



            - The viscous resistance coefficient.










393



            - The hydrodynamic resistance coefficient.










394



            - The average absolute pressure, if the data depend on pressure.










395



            - The average temperature, if the data depend on temperature.










396



            - The value of the first field variable, if the data depend on field variables.










397



            - The value of the second field variable.










398



            - Etc.










399














400



            Alternatively, the sequence data may specify the mass flow rate. This is applicable only










401



            when **definition** = MASS_FLUX. In this form, only one sequence is specified and that










402



            sequence contains the following data:










403














404



            - The mass flow rate per unit area.










405














406



            Alternatively, the sequence data may specify the mass rate leakage. This is applicable










407



            only when **definition** = MASS_RATE_LEAK. Each sequence contains the following data:










408














409



            - The absolute value of the mass flow rate per unit area. (The first tabular value










410



              entered must always be zero.)










411



            - The absolute value of the pressure difference. (The first tabular value entered must










412



              always be zero.)










413



            - The average absolute pressure, if the data depend on pressure.










414



            - The average temperature, if the data depend on temperature.










415



            - The value of the first field variable, if the data depend on field variables.










416



            - The value of the second field variable.










417



            - Etc.










418














419



            Alternatively, the sequence data may specify the volume flow rate. This is applicable










420



            only when **definition** = VOL_FLUX. In this form, only one sequence is specified and that










421



            sequence contains the following data:










422














423



            - The volumetric flow rate per unit area.










424














425



            Alternatively, the sequence data may specify the volume rate leakage. This is applicable










426



            only when **definition** = VOL_RATE_LEAK. Each sequence contains the following data:










427














428



            - The absolute value of the volumetric flow rate per unit area. (The first tabular value










429



              entered must always be zero.)










430



            - The absolute value of the pressure difference. (The first tabular value entered must










431



              always be zero.)










432



            - The average absolute pressure, if the data depend on pressure.










433



            - The average temperature, if the data depend on temperature.










434



            - The value of the first field variable, if the data depend on field variables.










435



            - The value of the second field variable.










436



            - Etc.










437














438



        definition










439



            A SymbolicConstant specifying the type of fluid exchange property to be defined.










440



            Possible values are BULK_VISCOSITY, MASS_FLUX, MASS_RATE_LEAK, VOL_FLUX, and










441



            VOL_RATE_LEAK. The default value is BULK_VISCOSITY.










442



        pressureDependency










443



            A Boolean specifying whether the data will have pressure dependency. This argument is










444



            applicable only when **definition** = BULK_VISCOSITY, or when **definition** = MASS_RATE_LEAK,










445



            or when **definition** = VOL_RATE_LEAK. The default value is OFF.










446



        temperatureDependency










447



            A Boolean specifying whether the data will have temperature dependency. This argument is










448



            applicable only when **definition** = BULK_VISCOSITY, or when **definition** = MASS_RATE_LEAK,










449



            or when **definition** = VOL_RATE_LEAK. The default value is OFF.










450



        fieldDependencies










451



            An Int specifying the number of field variable dependencies in the data. This argument










452



            is applicable only when **definition** = BULK_VISCOSITY, or when










453



            **definition** = MASS_RATE_LEAK, or when **definition** = VOL_RATE_LEAK. The default value is 0.










454














455



        Returns










456



        -------










457



        FluidExchangeProperty










458



            A FluidExchangeProperty object.










459



        """










460



        self.interactionProperties[name] = interactionProperty = FluidExchangeProperty(




×







461



            name,










462



            dataTable,










463



            definition,










464



            pressureDependency,










465



            temperatureDependency,










466



            fieldDependencies,










467



        )










468



        return interactionProperty




×







469












470



    @abaqus_method_doc




1✔





471



    def FluidInflatorProperty(




1✔





472



        self,










473



        name: str,










474



        definition: str,










475



        effectiveArea: float,










476



        tankVolume: float,










477



        dischargeCoefficient: float | None = None,










478



        dataTable: tuple = (),










479



        numFluids: int | None = None,










480



        mixtureType: str = "",










481



        inflationTime: tuple = (),










482



        fluidbehaviorName: tuple = (),










483



        massFraction: tuple = (),










484



    ) -> FluidInflatorProperty:










485



        """This method creates a FluidInflatorProperty object.










486














487



        .. note::










488



            This function can be accessed by::










489














490



                mdb.models[name].FluidInflatorProperty










491














492



        .. versionadded:: 2019










493



            The ``FluidInflatorProperty`` method was added.










494














495



        Parameters










496



        ----------










497



        name










498



            A String specifying the interaction property repository key.










499



        definition










500



            A Symbolic constant specifying the method used for modeling the flow characteristics of










501



            inflators. The default value is **definition** = DUAL PRESSURE. The possible values are DUAL










502



            PRESSURE, PRESSURE AND MASS, TANK TEST, and TEMPERATURE AND MASS.










503



        effectiveArea










504



            A Float specifying the total inflator orifice area. This argument is applicable only if










505



            **definition** = DUAL PRESSURE or **definition** = PRESSURE AND MASS.










506



        tankVolume










507



            A Float specifying the tank volume. This argument is applicable only if










508



            **definition** = DUAL PRESSURE or **definition** = TANK TEST.










509



        dischargeCoefficient










510



            A Float specifying the discharge coefficient. This argument is applicable only if










511



            **definition** = DUAL PRESSURE or **definition** = PRESSURE AND MASS.










512



        dataTable










513



            A sequence of sequences of Floats specifying the items described in the "Table data"










514



            section below.










515



        numFluids










516



            An Int specifying the number of gas species used for this inflator.










517



        mixtureType










518



            A Symbolic constant specifying whether to use mass fraction or the molar fraction for a










519



            mixture of ideal gases. The default value is MASS FRACTION. The possible values are MASS










520



            FRACTION or MOLAR FRACTION.










521



        inflationTime










522



            A sequence of sequences of Floats specifying the inflation time.










523



        fluidbehaviorName










524



            A sequence of sequences of Strings specifying fluid behavior names.










525



        massFraction










526



            A sequence of sequences of Floats specifying the mass fraction or the molar fraction










527



            corresponding to entered fluid behavior.










528














529



        Returns










530



        -------










531



            A FluidInflatorProperty object.










532



        """










533



        self.interactionProperties[name] = interactionProperty = FluidInflatorProperty(




×







534



            name,










535



            definition,










536



            effectiveArea,










537



            tankVolume,










538



            dischargeCoefficient,










539



            dataTable,










540



            numFluids,










541



            mixtureType,










542



            inflationTime,










543



            fluidbehaviorName,










544



            massFraction,










545



        )










546



        return interactionProperty




×







547













548



    @abaqus_method_doc




1✔






549



    def GapDiffusivity(




1✔





550



        self,










551



        type: Literal[C.ION_CONCENTRATION, C.SPECIES_CONCENTRATION],










552



        cutoffFlowAcrossDist: float | None = None,










553



        cutoffGapFillDist: float | None = None,










554



        dependencies: int = 0,










555



        concentrationDepTable: tuple = (),










556



    ):










557



        """This method creates a GapDiffusivity object.










558














559



        .. note::










560



            This function can be accessed by::










561














562



                mdb.models[name].interactionProperties[name].Diffusivity










563














564



        Parameters










565



        ----------










566



        type










567



            A SymbolicConstant specifying how the contact diffusivity is










568



            defined. Possible values are ``ION_CONCENTRATION`` and










569



            ``SPECIES_CONCENTRATION``.










570



        cutoffFlowAcrossDist










571



            A Float specifying a cutoff clearance distance above which no ion










572



            or species diffusion occurs across a contact interface.










573



        cutoffGapFillDist










574



            A Float specifying a cutoff clearance distance above which no ion










575



            or species diffusion occurs into or out of a contact interface due










576



            to changes in the clearance distance.










577



        dependencies










578



            An Int specifying the number of field variables to use with










579



            clearance dependency. The default value is 0.










580



        concentrationDepTable










581



            A sequence of sequences of Floats specifying concentration










582



            dependency data.










583














584



            For ``type=ION_CONCENTRATION``, each sequence contains the










585



            following values:










586














587



            - Contact diffusivity.










588



            - Contact pressure.










589



            - Average ion concentration.










590



            - Average temperature.










591



            - Values of the field variables, if applicable.










592














593



            For ``type=SPECIES_CONCENTRATION``, each sequence contains the










594



            following values:










595














596



            - Contact diffusivity.










597



            - Contact pressure.










598



            - Average species concentration.










599



            - Average temperature.










600



            - Values of the field variables, if applicable.










601














602



        Returns










603



        -------










604



            A GapDiffusivity object.










605



        """











NEW


606



        self.interactionProperties[""] = interactionProperty = GapDiffusivity(




×







607



            type,










608



            cutoffFlowAcrossDist,










609



            cutoffGapFillDist,










610



            dependencies,










611



            concentrationDepTable,










612



        )











NEW


613



        return interactionProperty




×







614












615



    @abaqus_method_doc




1✔





616



    def IncidentWaveProperty(




1✔





617



        self,










618



        name: str,










619



        definition: Literal[C.PLANAR, C.SPHERICAL, C.DIFFUSE, C.SURFACE_BLAST, C.AIR_BLAST] = PLANAR,










620



        propagationModel: Literal[C.ACOUSTIC, C.SPHERICAL, C.GENERALIZED_DECAY, C.UNDEX_CHARGE] = ACOUSTIC,










621



        soundSpeed: float | None = None,










622



        fluidDensity: float | None = None,










623



        specificHeatRatio: float | None = None,










624



        gravity: float | None = None,










625



        atmosphericPressure: float | None = None,










626



        dragCoefficient: float | None = None,










627



        dragExponent: float = 2,










628



        waveEffects: Boolean = ON,










629



        chargeDensity: float | None = None,










630



        chargeMass: float | None = None,










631



        constantK1: float | None = None,










632



        constantK2: float | None = None,










633



        constantA: float | None = None,










634



        constantB: float | None = None,










635



        constantKc: float | None = None,










636



        duration: float | None = None,










637



        maximumSteps: int = 1500,










638



        relativeStepControl: float | None = None,










639



        absoluteStepControl: float | None = None,










640



        stepControlExponent: float = 0,










641



        genDecayA: float = 0,










642



        genDecayB: float = 0,










643



        genDecayC: float = 0,










644



        seedNumber: int | None = None,










645



        massTNT: float | None = None,










646



        massFactor: float = 1,










647



        lengthFactor: float = 1,










648



        timeFactor: float = 1,










649



        pressureFactor: float = 1,










650



    ) -> IncidentWaveProperty:










651



        """This method creates an IncidentWaveProperty object.










652














653



        .. note::










654



            This function can be accessed by::










655














656



                mdb.models[name].IncidentWaveProperty










657














658



        Parameters










659



        ----------










660



        name










661



            A String specifying the interaction property repository key.










662



        definition










663



            A SymbolicConstant specifying the type of wave to be defined. Possible values are










664



            PLANAR, SPHERICAL, DIFFUSE, AIR_BLAST, and SURFACE_BLAST. The default value is PLANAR.










665



        propagationModel










666



            A SymbolicConstant specifying the spherical propagation model. Possible values are










667



            ACOUSTIC, UNDEX_CHARGE, and GENERALIZED_DECAY. The default value is ACOUSTIC.This










668



            argument is valid only when **definition** = SPHERICAL.










669



        soundSpeed










670



            A Float specifying the speed of sound in the fluid.This argument is not valid when










671



            **definition** = AIR_BLAST or when **definition** = SURFACE_BLAST.










672



        fluidDensity










673



            A Float specifying the fluid mass density.This argument is not valid when










674



            **definition** = AIR_BLAST or when **definition** = SURFACE_BLAST.










675



        specificHeatRatio










676



            None or a Float specifying the ratio of specific heats for gas. The default value is










677



            None.This argument is valid only when **definition** = SPHERICAL and










678



            **propagationModel** = UNDEX_CHARGE.










679



        gravity










680



            None or a Float specifying the acceleration due to gravity. The default value is










681



            None.This argument is valid only when **definition** = SPHERICAL and










682



            **propagationModel** = UNDEX_CHARGE.










683



        atmosphericPressure










684



            None or a Float specifying the atmospheric pressure. The default value is None.This










685



            argument is valid only when **definition** = SPHERICAL and **propagationModel** = UNDEX_CHARGE.










686



        dragCoefficient










687



            None or a Float specifying the fluid drag coefficient. The default value is None.This










688



            argument is valid only when **definition** = SPHERICAL and **propagationModel** = UNDEX_CHARGE.










689



        dragExponent










690



            A Float specifying the fluid drag exponent. The default value is 2.0.This argument is










691



            valid only when **definition** = SPHERICAL and **propagationModel** = UNDEX_CHARGE.










692



        waveEffects










693



            A Boolean specifying whether or not to include wave effects in the fluid and gas. The










694



            default value is ON.This argument is valid only when **definition** = SPHERICAL and










695



            **propagationModel** = UNDEX_CHARGE.










696



        chargeDensity










697



            None or a Float specifying the density of the charge material. The default value is










698



            None.This argument is valid only when **definition** = SPHERICAL and










699



            **propagationModel** = UNDEX_CHARGE.










700



        chargeMass










701



            None or a Float specifying the mass of the charge material. The default value is










702



            None.This argument is valid only when **definition** = SPHERICAL and










703



            **propagationModel** = UNDEX_CHARGE.










704



        constantK1










705



            None or a Float specifying the charge material constant K. The default value is










706



            None.This argument is valid only when **definition** = SPHERICAL and










707



            **propagationModel** = UNDEX_CHARGE.










708



        constantK2










709



            None or a Float specifying the charge material constant k. The default value is










710



            None.This argument is valid only when **definition** = SPHERICAL and










711



            **propagationModel** = UNDEX_CHARGE.










712



        constantA










713



            None or a Float specifying the charge material constant A. The default value is










714



            None.This argument is valid only when **definition** = SPHERICAL and










715



            **propagationModel** = UNDEX_CHARGE.










716



        constantB










717



            None or a Float specifying the charge material constant B. The default value is










718



            None.This argument is valid only when **definition** = SPHERICAL and










719



            **propagationModel** = UNDEX_CHARGE.










720



        constantKc










721



            None or a Float specifying the charge material constant Kc. The default value is










722



            None.This argument is valid only when **definition** = SPHERICAL and










723



            **propagationModel** = UNDEX_CHARGE.










724



        duration










725



            None or a Float specifying the time duration for the bubble simulation. The default










726



            value is None.This argument is valid only when **definition** = SPHERICAL and










727



            **propagationModel** = UNDEX_CHARGE.










728



        maximumSteps










729



            An Int specifying the maximum number of time steps for the bubble simulation. The










730



            default value is 1500.This argument is valid only when **definition** = SPHERICAL and










731



            **propagationModel** = UNDEX_CHARGE.










732



        relativeStepControl










733



            A Float specifying the relative step size control parameter. The default value is










734



            1x10⁻¹¹.This argument is valid only when **definition** = SPHERICAL and










735



            **propagationModel** = UNDEX_CHARGE.










736



        absoluteStepControl










737



            A Float specifying the absolute step size control parameter. The default value is










738



            1x10⁻¹¹.This argument is valid only when **definition** = SPHERICAL and










739



            **propagationModel** = UNDEX_CHARGE.










740



        stepControlExponent










741



            A Float specifying the step size control exponent. The default value is 0.2.This










742



            argument is valid only when **definition** = SPHERICAL and **propagationModel** = UNDEX_CHARGE.










743



        genDecayA










744



            A Float specifying the constant A associated with the generalized decay propagation










745



            model. The default value is 0.0.This argument is valid only when **definition** = SPHERICAL










746



            and **propagationModel** = GENERALIZED_DECAY.










747



        genDecayB










748



            A Float specifying the constant B associated with the generalized decay propagation










749



            model. The default value is 0.0.This argument is valid only when **definition** = SPHERICAL










750



            and **propagationModel** = GENERALIZED_DECAY.










751



        genDecayC










752



            A Float specifying the constant C associated with the generalized decay propagation










753



            model. The default value is 0.0.This argument is valid only when **definition** = SPHERICAL










754



            and **propagationModel** = GENERALIZED_DECAY.










755



        seedNumber










756



            An Int specifying the seed number (N) for the diffuse source calculation. N2 sources










757



            will be used in the simulation.This argument is valid only when **definition** = DIFFUSE.










758



        massTNT










759



            A Float specifying the equivalent mass of TNT, in any preferred mass unit.This argument










760



            is valid only when **definition** = AIR_BLAST or **definition** = SURFACE_BLAST.










761



        massFactor










762



            A Float specifying the multiplication factor to convert from the preferred mass unit to










763



            kilograms. The default value is 1.0.This argument is valid only when










764



            **definition** = AIR_BLAST or **definition** = SURFACE_BLAST.










765



        lengthFactor










766



            A Float specifying the multiplication factor to convert from the analysis length unit to










767



            meters. The default value is 1.0.This argument is valid only when **definition** = AIR_BLAST










768



            or **definition** = SURFACE_BLAST.










769



        timeFactor










770



            A Float specifying the multiplication factor to convert from the analysis time unit to










771



            seconds. The default value is 1.0.This argument is valid only when










772



            **definition** = AIR_BLAST or **definition** = SURFACE_BLAST.










773



        pressureFactor










774



            A Float specifying the multiplication factor to convert from the analysis pressure unit










775



            to pascals. The default value is 1.0.This argument is valid only when










776



            **definition** = AIR_BLAST or **definition** = SURFACE_BLAST.










777














778



        Returns










779



        -------










780



        IncidentWaveProperty










781



            An IncidentWaveProperty object.










782



        """










783



        self.interactionProperties[name] = interactionProperty = IncidentWaveProperty(




×







784



            name,










785



            definition,










786



            propagationModel,










787



            soundSpeed,










788



            fluidDensity,










789



            specificHeatRatio,










790



            gravity,










791



            atmosphericPressure,










792



            dragCoefficient,










793



            dragExponent,










794



            waveEffects,










795



            chargeDensity,










796



            chargeMass,










797



            constantK1,










798



            constantK2,










799



            constantA,










800



            constantB,










801



            constantKc,










802



            duration,










803



            maximumSteps,










804



            relativeStepControl,










805



            absoluteStepControl,










806



            stepControlExponent,










807



            genDecayA,










808



            genDecayB,










809



            genDecayC,










810



            seedNumber,










811



            massTNT,










812



            massFactor,










813



            lengthFactor,










814



            timeFactor,










815



            pressureFactor,










816



        )










817



        return interactionProperty




×





















    

  • 

    •