pycatia.abq_automation_interfaces.abq_film_condition

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.abq_automation_interfaces.abq_film_condition.ABQFilmCondition(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

ABQAutomationItf.ABQLoad

ABQFilmCondition

Represents an Abaqus film condition (ABQFilmCondition) object.

Role: Access an Abaqus film condition object or determine its

properties.

add_temp_dependent_film_coeff_table(i_film_coeff: tuple, i_temperature: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub AddTempDependentFilmCoeffTable(CATSafeArrayVariant

iFilmCoeff,

CATSafeArrayVariant iTemperature)

Adds a list of temperature dependent film coefficients if the film

condition is temperature dependent. The number of values in both of the

parameters should match. If either list contains extra values, the extra values

are discarded.

Parameters:

iFilmCoeff

The list of film coefficients.

iTemperature

The list of temperatures.

Parameters:

• i_film_coeff (tuple) –

• i_temperature (tuple) –

Return type:

None

property apply_user_subroutine: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property ApplyUserSubroutine() As boolean

Sets or returns the user subroutine flag.

Returns:

A boolean specifying whether a nonuniform film coefficient is defined

in user subroutine FILM.

Return type:

bool

property dependencies: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property dependencies() As long (Read Only)

Returns the number of temperature-dependent film

coefficients.

Returns:

The number of temperature-dependent film coefficients.

Return type:

int

property film_coefficient: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property filmCoeff() As double

Sets or returns the reference film coefficient if the film condition is not

temperature dependent.

Returns:

The reference film coefficient if the film condition is not temperature

dependent.

Return type:

float

get_name_of_film_coeff_amplitude() → str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub GetNameOfFilmCoeffAmplitude(CATBSTR ofilmAmplitude)

Returns the name of the amplitude that contains the variation of the the

film coefficient with time.

Parameters:

ofilmAmplitude

The name of the amplitude that contains the variation of the the

film coefficient with time.

Parameters:

ofilm_amplitude (str) –

Return type:

None

get_name_of_sink_amplitude() → str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub GetNameOfSinkAmplitude(CATBSTR osinkAmplitude)

Returns the name of the amplitude that contains the variation of the sink

temperature with time.

Parameters:

osinkAmplitude

The name of the amplitude that contains the variation of the sink

temperature with time.

Parameters:

osink_amplitude (str) –

Return type:

None

get_temp_dependent_film_coeff_table() → list

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub GetTempDependentFilmCoeffTable(CATSafeArrayVariant

oFilmCoeff,

CATSafeArrayVariant oTemperature)

Returns a list of temperature dependent film coefficients if the film

condition is temperature dependent.

Parameters:

oFilmCoeff

The list of film coefficients.

oTemperature

The list of temperatures.

Parameters:

• o_film_coeff (tuple) –

• o_temperature (tuple) –

Return type:

None

set_named_film_coeff_amplitude(ifilm_amplitude: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetNamedFilmCoeffAmplitude(CATBSTR ifilmAmplitude)

Sets the name of the amplitude that gives the variation of the the film

coefficient with time.

Parameters:

ifilmAmplitude

The name of the amplitude that gives the variation of the the film

coefficient with time.

Parameters:

ifilm_amplitude (str) –

Return type:

None

set_named_sink_amplitude(isink_amplitude: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetNamedSinkAmplitude(CATBSTR isinkAmplitude)

Sets the name of the amplitude that contains the variation of the sink

temperature with time.

Parameters:

isinkAmplitude

The name of the amplitude that contains the variation of the sink

temperature with time.

Parameters:

isink_amplitude (str) –

Return type:

None

property sink_temperature: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property sinkTemperature() As double

Sets or returns the reference sink temperature.

Returns:

The reference sink temperature.

Return type:

float

property temperature_dependency: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property temperatureDependency() As boolean

Sets or returns the temperature dependency.

Returns:

A boolean specifying whether the film condition is dependent on

temperature.

Return type:

bool