Oasys.PRIMER.IntegrationBeam class

Properties

property IntegrationBeam.d1: float

Cross-section dimension

property IntegrationBeam.d2: float

Cross-section dimension

property IntegrationBeam.d3: float

Cross-section dimension

property IntegrationBeam.d4: float

Cross-section dimension

property IntegrationBeam.d5: float

Cross-section dimension

property IntegrationBeam.d6: float

Cross-section dimension

property IntegrationBeam.exists(read only): boolean

true if intb exists, false if referred to but not defined

property IntegrationBeam.icst: integer

Standard cross section type. If icst is non-zero, nip should be zero and vice-versa

property IntegrationBeam.include: integer

The Include file number that the intb is in

property IntegrationBeam.irid: integer

Integration rule id

property IntegrationBeam.k: integer

Integration refinement parameter for standard cross section types

property IntegrationBeam.model(read only): integer

The Model number that the integration beam is in

property IntegrationBeam.nip: integer

Number of integration points. If nip is non-zero, icst should be zero and vice-versa

property IntegrationBeam.pid: Part

Optional part ID if different from the PID specified on the element card

property IntegrationBeam.ra: float

Relative area of cross section

property IntegrationBeam.s: float

Normalized s coordinate of integration point

property IntegrationBeam.sref: float

Location of reference surface normal to s, for the Hughes-Liu beam only

property IntegrationBeam.t: float

Normalized t coordinate of integration point

property IntegrationBeam.tref: float

Location of reference surface normal to t, for the Hughes-Liu beam only

property IntegrationBeam.wf: float

Weighting factor (area associated with integration point divided by actual cross sectional area)

Constructor

classmethod IntegrationBeam(model, irid, nip=Oasys.gRPC.defaultArg, ra=Oasys.gRPC.defaultArg, icst=Oasys.gRPC.defaultArg, k=Oasys.gRPC.defaultArg)

Create a new IntegrationBeam object

Parameters:

  • model (Model) – Model that intb will be created in

  • irid (integer) – Integration_Beam ID

  • nip (integer) – Optional. Number of integration points. If omitted nip will be 0. If nip is non-zero, icst should be zero and vice-versa

  • ra (float) – Optional. Relative area of cross section. If omitted ra will be 0

  • icst (integer) – Optional. Standard cross section type. If omitted icst will be 0. If icst is non-zero, nip should be zero and vice-versa

  • k (integer) – Optional. Integration refinement parameter for standard cross section types. If omitted k will be 0

Returns:

IntegrationBeam object

Return type:

dict

Example

To create a new intgb 1000 in model m with the following specifiction: irid, nip, ra, icst, k are 1000, 2, 0.1, 3, 5 respectively

w = Oasys.PRIMER.IntegrationBeam(m, 1000, 2, 0.1, 3, 5)

Static methods

classmethod IntegrationBeam.Create(model, modal=Oasys.gRPC.defaultArg)

Starts an interactive editing panel to create a intb

Parameters:

  • model (Model) – Model that the intb will be created in

  • modal (boolean) – Optional. If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal

Returns:

IntegrationBeam object (or None if not made)

Return type:

dict

Example

To start creating a intb n in model m:

n = Oasys.PRIMER.IntegrationBeam.Create(m)
classmethod IntegrationBeam.First(model)

Returns the first integration beam in the model

Parameters:

model (Model) – Model to get first integration beam in

Returns:

IntegrationBeam object (or None if there are no integration beams in the model)

Return type:

IntegrationBeam

Example

To get the first integration beam in model m:

ib = Oasys.PRIMER.IntegrationBeam.First(m)
classmethod IntegrationBeam.FirstFreeLabel(model, layer=Oasys.gRPC.defaultArg)

Returns the first free integration beam label in the model. Also see IntegrationBeam.LastFreeLabel(), IntegrationBeam.NextFreeLabel() and Model.FirstFreeItemLabel()

Parameters:

  • model (Model) – Model to get first free integration beam label in

  • layer (Include number) – Optional. Include file (0 for the main file) to search for labels in (Equivalent to First free in layer in editing panels). If omitted the whole model will be used (Equivalent to First free in editing panels)

Returns:

IntegrationBeam label

Return type:

int

Example

To get the first free integration beam label in model m:

label = Oasys.PRIMER.IntegrationBeam.FirstFreeLabel(m)
classmethod IntegrationBeam.FlagAll(model, flag)

Flags all of the integration beams in the model with a defined flag

Parameters:

  • model (Model) – Model that all integration beams will be flagged in

  • flag (Flag) – Flag to set on the integration beams

Returns:

No return value

Return type:

None

Example

To flag all of the integration beams with flag f in model m:

Oasys.PRIMER.IntegrationBeam.FlagAll(m, f)
classmethod IntegrationBeam.GetAll(model)

Returns a list of IntegrationBeam objects for all of the integration beams in a model in PRIMER

Parameters:

model (Model) – Model to get integration beams from

Returns:

List of IntegrationBeam objects

Return type:

list

Example

To make a list of IntegrationBeam objects for all of the integration beams in model m

ib = Oasys.PRIMER.IntegrationBeam.GetAll(m)
classmethod IntegrationBeam.GetFlagged(model, flag)

Returns a list of IntegrationBeam objects for all of the flagged integration beams in a model in PRIMER

Parameters:

  • model (Model) – Model to get integration beams from

  • flag (Flag) – Flag set on the integration beams that you want to retrieve

Returns:

List of IntegrationBeam objects

Return type:

list

Example

To make a list of IntegrationBeam objects for all of the integration beams in model m flagged with f

ib = Oasys.PRIMER.IntegrationBeam.GetFlagged(m, f)
classmethod IntegrationBeam.GetFromID(model, number)

Returns the IntegrationBeam object for a integration beam ID

Parameters:

  • model (Model) – Model to find the integration beam in

  • number (integer) – number of the integration beam you want the IntegrationBeam object for

Returns:

IntegrationBeam object (or None if integration beam does not exist)

Return type:

IntegrationBeam

Example

To get the IntegrationBeam object for integration beam 100 in model m

ib = Oasys.PRIMER.IntegrationBeam.GetFromID(m, 100)
classmethod IntegrationBeam.Last(model)

Returns the last integration beam in the model

Parameters:

model (Model) – Model to get last integration beam in

Returns:

IntegrationBeam object (or None if there are no integration beams in the model)

Return type:

IntegrationBeam

Example

To get the last integration beam in model m:

ib = Oasys.PRIMER.IntegrationBeam.Last(m)
classmethod IntegrationBeam.LastFreeLabel(model, layer=Oasys.gRPC.defaultArg)

Returns the last free integration beam label in the model. Also see IntegrationBeam.FirstFreeLabel(), IntegrationBeam.NextFreeLabel() and see Model.LastFreeItemLabel()

Parameters:

  • model (Model) – Model to get last free integration beam label in

  • layer (Include number) – Optional. Include file (0 for the main file) to search for labels in (Equivalent to Highest free in layer in editing panels). If omitted the whole model will be used

Returns:

IntegrationBeam label

Return type:

int

Example

To get the last free integration beam label in model m:

label = Oasys.PRIMER.IntegrationBeam.LastFreeLabel(m)
classmethod IntegrationBeam.NextFreeLabel(model, layer=Oasys.gRPC.defaultArg)

Returns the next free (highest+1) integration beam label in the model. Also see IntegrationBeam.FirstFreeLabel(), IntegrationBeam.LastFreeLabel() and Model.NextFreeItemLabel()

Parameters:

  • model (Model) – Model to get next free integration beam label in

  • layer (Include number) – Optional. Include file (0 for the main file) to search for labels in (Equivalent to Highest+1 in layer in editing panels). If omitted the whole model will be used (Equivalent to Highest+1 in editing panels)

Returns:

IntegrationBeam label

Return type:

int

Example

To get the next free integration beam label in model m:

label = Oasys.PRIMER.IntegrationBeam.NextFreeLabel(m)
classmethod IntegrationBeam.RenumberAll(model, start)

Renumbers all of the integration beams in the model

Parameters:

  • model (Model) – Model that all integration beams will be renumbered in

  • start (integer) – Start point for renumbering

Returns:

No return value

Return type:

None

Example

To renumber all of the integration beams in model m, from 1000000:

Oasys.PRIMER.IntegrationBeam.RenumberAll(m, 1000000)
classmethod IntegrationBeam.RenumberFlagged(model, flag, start)

Renumbers all of the flagged integration beams in the model

Parameters:

  • model (Model) – Model that all the flagged integration beams will be renumbered in

  • flag (Flag) – Flag set on the integration beams that you want to renumber

  • start (integer) – Start point for renumbering

Returns:

No return value

Return type:

None

Example

To renumber all of the integration beams in model m flagged with f, from 1000000:

Oasys.PRIMER.IntegrationBeam.RenumberFlagged(m, f, 1000000)
classmethod IntegrationBeam.Select(flag, prompt, limit=Oasys.gRPC.defaultArg, modal=Oasys.gRPC.defaultArg)

Allows the user to select integration beams using standard PRIMER object menus

Parameters:

  • flag (Flag) – Flag to use when selecting integration beams

  • prompt (string) – Text to display as a prompt to the user

  • limit (Model or Flag) – Optional. If the argument is a Model then only integration beams from that model can be selected. If the argument is a Flag then only integration beams that are flagged with limit can be selected (limit should be different to flag). If omitted, or None, any integration beams can be selected. from any model

  • modal (boolean) – Optional. If selection is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the selection will be modal

Returns:

Number of integration beams selected or None if menu cancelled

Return type:

int

Example

To select integration beams from model m, flagging those selected with flag f, giving the prompt ‘Select integration beams’:

Oasys.PRIMER.IntegrationBeam.Select(f, 'Select integration beams', m)

To select integration beams, flagging those selected with flag f but limiting selection to integration beams flagged with flag l, giving the prompt ‘Select integration beams’:

Oasys.PRIMER.IntegrationBeam.Select(f, 'Select integration beams', l)
classmethod IntegrationBeam.Total(model, exists=Oasys.gRPC.defaultArg)

Returns the total number of integration beams in the model

Parameters:

  • model (Model) – Model to get total for

  • exists (boolean) – Optional. true if only existing integration beams should be counted. If false or omitted referenced but undefined integration beams will also be included in the total

Returns:

number of integration beams

Return type:

int

Example

To get the total number of integration beams in model m:

total = Oasys.PRIMER.IntegrationBeam.Total(m)
classmethod IntegrationBeam.UnflagAll(model, flag)

Unsets a defined flag on all of the integration beams in the model

Parameters:

  • model (Model) – Model that the defined flag for all integration beams will be unset in

  • flag (Flag) – Flag to unset on the integration beams

Returns:

No return value

Return type:

None

Example

To unset the flag f on all the integration beams in model m:

Oasys.PRIMER.IntegrationBeam.UnflagAll(m, f)

Instance methods

IntegrationBeam.AssociateComment(comment)

Associates a comment with a integration beam

Parameters:

comment (Comment) – Comment that will be attached to the integration beam

Returns:

No return value

Return type:

None

Example

To associate comment c to the integration beam ib:

ib.AssociateComment(c)
IntegrationBeam.Browse(modal=Oasys.gRPC.defaultArg)

Starts an edit panel in Browse mode

Parameters:

modal (boolean) – Optional. If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal

Returns:

no return value

Return type:

None

Example

To Browse integration beam ib:

ib.Browse()
IntegrationBeam.ClearFlag(flag)

Clears a flag on the integration beam

Parameters:

flag (Flag) – Flag to clear on the integration beam

Returns:

No return value

Return type:

None

Example

To clear flag f for integration beam ib:

ib.ClearFlag(f)
IntegrationBeam.Copy(range=Oasys.gRPC.defaultArg)

Copies the integration beam. The target include of the copied integration beam can be set using Options.copy_target_include

Parameters:

range (boolean) – Optional. If you want to keep the copied item in the range specified for the current include. Default value is false. To set current include, use Include.MakeCurrentLayer()

Returns:

IntegrationBeam object

Return type:

IntegrationBeam

Example

To copy integration beam ib into integration beam z:

z = ib.Copy()
IntegrationBeam.DetachComment(comment)

Detaches a comment from a integration beam

Parameters:

comment (Comment) – Comment that will be detached from the integration beam

Returns:

No return value

Return type:

None

Example

To detach comment c from the integration beam ib:

ib.DetachComment(c)
IntegrationBeam.Edit(modal=Oasys.gRPC.defaultArg)

Starts an interactive editing panel

Parameters:

modal (boolean) – Optional. If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal

Returns:

no return value

Return type:

None

Example

To Edit integration beam ib:

ib.Edit()
IntegrationBeam.Flagged(flag)

Checks if the integration beam is flagged or not

Parameters:

flag (Flag) – Flag to test on the integration beam

Returns:

True if flagged, False if not

Return type:

bool

Example

To check if integration beam ib has flag f set on it:

if ib.Flagged(f):
    do_something..
IntegrationBeam.GetComments()

Extracts the comments associated to a integration beam

Returns:

List of Comment objects (or None if there are no comments associated to the node)

Return type:

list

Example

To get the list of comments associated to the integration beam ib:

comm_list = ib.GetComments()
IntegrationBeam.GetIntegrationPoint(index)

Returns the data for an integration point in *INTEGRATION_BEAM.**Note data is only available when NIP>0**

Parameters:

index (integer) – Index you want the integration point data for. Note that indices start at 0

Returns:

A list containing the integration point data

Return type:

list

Example

To get the data for the 3rd integration point for integration beam ib:

data = ib.GetIntegrationPoint(2)
IntegrationBeam.GetParameter(prop)

Checks if a IntegrationBeam property is a parameter or not. Note that object properties that are parameters are normally returned as the integer or float parameter values as that is virtually always what the user would want. For this function to work the JavaScript interpreter must use the parameter name instead of the value. This can be done by setting the Options.property_parameter_names option to true before calling the function and then resetting it to false afterwards.. This behaviour can also temporarily be switched by using the IntegrationBeam.ViewParameters() method and ‘method chaining’ (see the examples below)

Parameters:

prop (string) – integration beam property to get parameter for

Returns:

Parameter object if property is a parameter, None if not

Return type:

dict

Example

To check if IntegrationBeam property ib.example is a parameter:

Oasys.PRIMER.Options.property_parameter_names = True
if ib.GetParameter(ib.example):
    do_something...
Oasys.PRIMER.Options.property_parameter_names = False

To check if IntegrationBeam property ib.example is a parameter by using the GetParameter method:

if ib.ViewParameters().GetParameter(ib.example):
    do_something..
IntegrationBeam.Keyword()

Returns the keyword for this intb (*INTEGRATION_BEAM). Note that a carriage return is not added. See also IntegrationBeam.KeywordCards()

Returns:

string containing the keyword

Return type:

str

Example

To get the keyword for intb n:

key = n.Keyword()
IntegrationBeam.KeywordCards()

Returns the keyword cards for the intb. Note that a carriage return is not added. See also IntegrationBeam.Keyword()

Returns:

string containing the cards

Return type:

str

Example

To get the cards for intb n:

cards = n.KeywordCards()
IntegrationBeam.Next()

Returns the next integration beam in the model

Returns:

IntegrationBeam object (or None if there are no more integration beams in the model)

Return type:

IntegrationBeam

Example

To get the integration beam in model m after integration beam ib:

ib = ib.Next()
IntegrationBeam.Previous()

Returns the previous integration beam in the model

Returns:

IntegrationBeam object (or None if there are no more integration beams in the model)

Return type:

IntegrationBeam

Example

To get the integration beam in model m before integration beam ib:

ib = ib.Previous()
IntegrationBeam.SetFlag(flag)

Sets a flag on the integration beam

Parameters:

flag (Flag) – Flag to set on the integration beam

Returns:

No return value

Return type:

None

Example

To set flag f for integration beam ib:

ib.SetFlag(f)
IntegrationBeam.SetIntegrationPoint(index, s, t, wf, pid=Oasys.gRPC.defaultArg)

Sets the integration point data for an *INTEGRATION_BEAM

Parameters:

  • index (integer) – Index you want to set the integration point data for. Note that indices start at 0

  • s (float) – s coordinate of integration point in range -1 to 1

  • t (float) – s coordinate of integration point in range -1 to 1

  • wf (float) – Weighting factor, area associated with the integration point divided by actual beam cross sectional area

  • pid (integer) – Optional. Optional part ID if different from the PID specified on the element card

Returns:

No return value

Return type:

None

Example

To set the 4th integration point for *INTEGRATION_BEAM ib to the following specifiction: s, t, wf, pid are 0.1, 0.2, 0.3, 1 respectively

ib.SetIntegrationPoint(3, 0.1, 0.2, 0.3, 1)
IntegrationBeam.ViewParameters()

Object properties that are parameters are normally returned as the integer or float parameter values as that is virtually always what the user would want. This function temporarily changes the behaviour so that if a property is a parameter the parameter name is returned instead. This can be used with ‘method chaining’ (see the example below) to make sure a property argument is correct

Returns:

IntegrationBeam object

Return type:

dict

Example

To check if IntegrationBeam property ib.example is a parameter by using the IntegrationBeam.GetParameter() method:

if ib.ViewParameters().GetParameter(ib.example):
    do_something..
IntegrationBeam.Xrefs()

Returns the cross references for this integration beam

Returns:

Xrefs object

Return type:

dict

Example

To get the cross references for integration beam ib:

xrefs = ib.Xrefs()