GeneralStep

class compas_fea2.problem.GeneralStep

Bases: _Step

General Step object for use as a base class in a general static, dynamic or multiphysics analysis.

Parameters:

max_incrementsint

Max number of increments to perform during the case step. (Typically 100 but you might have to increase it in highly non-linear problems. This might increase the analysis time.).

initial_inc_sizefloat

Sets the the size of the increment for the first iteration. (By default is equal to the total time, meaning that the software decrease the size automatically.)

min_inc_sizefloat

Minimum increment size before stopping the analysis. (By default is 1e-5, but you can set a smaller size for highly non-linear problems. This might increase the analysis time.)

timefloat

Total time of the case step. Note that this not actual ‘time’, but rather a proportionality factor. (By default is 1, meaning that the analysis is complete when all the increments sum up to 1)

nlgeombool

if True nonlinear geometry effects are considered.

modifybool

if True the loads applied in a previous step are substituted by the ones defined in the present step, otherwise the loads are added.

restartfloat, optional

Frequency at which saving the results for restarting the analysis, by default False.

Attributes:

namestr

Automatically generated id. You can change the name if you want a more human readable input file.

max_incrementsint

Return the maximum number of increments for the step.

initial_inc_sizefloat

Return the initial increment size for the step.

min_inc_sizefloat

Return the minimum increment size for the step.

timefloat

Return the total time for the step.

nlgeombool

Return whether nonlinear geometry effects are considered in the step.

modifybool

Return whether the loads are modified in the step.

restartfloat

Return the restart frequency for the step.

loadsdict

Return the loads associated with the step.

fieldsdict

Return the fields associated with the step.

Methods

add_combination	Add a combination to the Step.
add_field	Add a general compas_fea2.problem.patterns.Pattern to the Step.
add_gravity_field	Add a compas_fea2.problem.GravityLoad load to the Step
add_load_fields	Add multiple compas_fea2.problem.patterns.Pattern to the Problem.
add_surface_field	Add a compas_fea2.problem.PointLoad subclass object to the Step along a prescribed path.
add_temperature_field	Add a temperature field to the Step object.
add_uniform_displacement_field	Add a uniform displacement field to the Step object.
add_uniform_forcefield	Add a compas_fea2.problem.fields.NodeLoadField where all the nodes have the same load.
add_uniform_forcefield_from_polygon
add_uniform_line_field	Add a compas_fea2.problem.field.NodeLoadField subclass object to the Step along a prescribed path.

Inherited Methods

ToString	Converts the instance to a string.
add_field_output	Add a field output to the step. Parameters ---------- field_output : compas_fea2.problem.fields.FieldType The field output to add. Returns ------- compas_fea2.problem.fields.FieldType.
add_field_outputs	Add multiple field outputs to the step. Parameters ---------- field_outputs : list(compas_fea2.problem.fields.FieldType) The field outputs to add to the step. Returns ------- list(compas_fea2.problem.fields.FieldType).
copy	Make an independent copy of the data object.
from_json	Construct an object of this type from a JSON file.
from_jsonstring	Construct an object of this type from a JSON string.
sha256	Compute a hash of the data for comparison during version control using the sha256 algorithm.
to_json	Convert an object to its native data representation and save it to a JSON file.
to_jsonstring	Convert an object to its native data representation and save it to a JSON string.
validate_data	Validate the data against the object's data schema.