stem package

Subpackages

• stem.IO package
  • Submodules
    • stem.IO.io_utils module
      • IOUtils
    • stem.IO.kratos_additional_processes_io module
      • KratosAdditionalProcessesIO
    • stem.IO.kratos_boundaries_io module
      • KratosBoundariesIO
    • stem.IO.kratos_io module
      • ElementAdditionalProcessParameters
      • KratosIO
    • stem.IO.kratos_loads_io module
      • KratosLoadsIO
    • stem.IO.kratos_material_io module
      • KratosMaterialIO
    • stem.IO.kratos_output_io module
      • KratosOutputsIO
    • stem.IO.kratos_solver_io module
      • KratosSolverIO
    • stem.IO.kratos_water_processes_io module
      • KratosWaterProcessesIO

Submodules

• stem.additional_processes module
  • AdditionalProcessPart
    • AdditionalProcessPart.model_part_name
    • AdditionalProcessPart.parameters
  • AdditionalProcessesParametersABC
  • Excavation
    • Excavation.deactivate_body_model_part
  • ExtrapolateIntegrationPointToNodesParameters
    • ExtrapolateIntegrationPointToNodesParameters.list_of_variables
  • HingeParameters
    • HingeParameters.ROTATIONAL_STIFFNESS_AXIS_2
    • HingeParameters.ROTATIONAL_STIFFNESS_AXIS_3
  • ParameterFieldParameters
    • ParameterFieldParameters.field_file_names
    • ParameterFieldParameters.field_generator
    • ParameterFieldParameters.function_type
    • ParameterFieldParameters.property_names
    • ParameterFieldParameters.tiny_expr_function
• stem.boundary module
  • AbsorbingBoundary
    • AbsorbingBoundary.absorbing_factors
    • AbsorbingBoundary.get_element_name()
    • AbsorbingBoundary.is_constraint
    • AbsorbingBoundary.virtual_thickness
  • BoundaryParametersABC
    • BoundaryParametersABC.get_element_name()
    • BoundaryParametersABC.is_constraint
  • DisplacementConstraint
    • DisplacementConstraint.get_element_name()
    • DisplacementConstraint.is_constraint
    • DisplacementConstraint.is_fixed
    • DisplacementConstraint.value
  • RotationConstraint
    • RotationConstraint.get_element_name()
    • RotationConstraint.is_constraint
    • RotationConstraint.is_fixed
    • RotationConstraint.value
• stem.default_materials module
  • DefaultMaterial
    • DefaultMaterial.Rail_46E3_2D
    • DefaultMaterial.Rail_46E3_3D
    • DefaultMaterial.Rail_54E1_2D
    • DefaultMaterial.Rail_54E1_3D
    • DefaultMaterial.Rail_60E1_2D
    • DefaultMaterial.Rail_60E1_3D
  • RailTypes
    • RailTypes.rail_46E3
    • RailTypes.rail_54E1
    • RailTypes.rail_60E1
  • set_default_steel_rail_material()
• stem.field_generator module
  • FieldGeneratorABC
    • FieldGeneratorABC.generate()
    • FieldGeneratorABC.generated_fields
  • RandomFieldGenerator
    • RandomFieldGenerator.generate()
    • RandomFieldGenerator.generated_fields
• stem.geometry module
  • GeometricalObjectABC
    • GeometricalObjectABC.id
  • Geometry
    • Geometry.calculate_area_surface()
    • Geometry.calculate_centre_of_mass_surface()
    • Geometry.calculate_centre_of_mass_volume()
    • Geometry.calculate_centroid_of_line()
    • Geometry.calculate_centroid_of_surface()
    • Geometry.calculate_length_line()
    • Geometry.create_geometry_from_geo_data()
    • Geometry.create_geometry_from_gmsh_group()
    • Geometry.get_ordered_points_from_surface()
    • Geometry.to_dict()
  • Line
    • Line.create()
    • Line.id
  • Point
    • Point.create()
    • Point.id
  • Surface
    • Surface.create()
    • Surface.id
  • Volume
    • Volume.create()
    • Volume.id
• stem.globals module
  • ELEMENT_DATA
  • GlobalSettings
    • GlobalSettings.geometry_precision
    • GlobalSettings.gravity_value
    • GlobalSettings.time_step_precision
• stem.load module
  • GravityLoad
    • GravityLoad.active
    • GravityLoad.get_element_name()
    • GravityLoad.value
  • LineLoad
    • LineLoad.active
    • LineLoad.get_element_name()
    • LineLoad.value
  • LoadParametersABC
    • LoadParametersABC.get_element_name()
  • MovingLoad
    • MovingLoad.direction_signs
    • MovingLoad.get_element_name()
    • MovingLoad.load
    • MovingLoad.offset
    • MovingLoad.origin
    • MovingLoad.velocity
  • PointLoad
    • PointLoad.active
    • PointLoad.get_element_name()
    • PointLoad.value
  • SurfaceLoad
    • SurfaceLoad.active
    • SurfaceLoad.get_element_name()
    • SurfaceLoad.value
  • UvecLoad
    • UvecLoad.direction_signs
    • UvecLoad.get_element_name()
    • UvecLoad.origin
    • UvecLoad.uvec_file
    • UvecLoad.uvec_function_name
    • UvecLoad.uvec_model
    • UvecLoad.uvec_parameters
    • UvecLoad.uvec_state_variables
    • UvecLoad.velocity
    • UvecLoad.wheel_configuration
  • UvecSupportedModels
    • UvecSupportedModels.TEN_DOF
    • UvecSupportedModels.TWO_DOF
• stem.logger module
  • enable_writing_to_log_file()
• stem.mesh module
  • Element
  • ElementShape
    • ElementShape.QUADRILATERAL
    • ElementShape.TRIANGLE
  • Mesh
    • Mesh.calculate_centroids()
    • Mesh.create_mesh_from_gmsh_group()
    • Mesh.find_elements_connected_to_nodes()
  • MeshSettings
    • MeshSettings.constraints
    • MeshSettings.element_order
    • MeshSettings.set_structured_mesh_constraint_line()
    • MeshSettings.set_structured_mesh_constraint_surface()
    • MeshSettings.set_structured_mesh_constraint_volume()
  • Node
• stem.model module
  • Model
    • Model.add_all_layers_from_geo_file()
    • Model.add_boundary_condition_by_geometry_ids()
    • Model.add_boundary_condition_on_plane()
    • Model.add_boundary_condition_on_polygon()
    • Model.add_field()
    • Model.add_group_for_extrusion()
    • Model.add_hinge_on_beam()
    • Model.add_load_by_coordinates()
    • Model.add_load_by_geometry_ids()
    • Model.add_load_on_line_model_part()
    • Model.add_model_part_to_group()
    • Model.add_output_settings()
    • Model.add_output_settings_by_coordinates()
    • Model.add_soil_layer_by_coordinates()
    • Model.all_model_parts
    • Model.apply_additional_process()
    • Model.finalise()
    • Model.generate_extended_straight_track()
    • Model.generate_mesh()
    • Model.generate_straight_track()
    • Model.get_all_nodes()
    • Model.get_bounding_box_soil()
    • Model.get_model_part_by_name()
    • Model.get_points_outside_soil()
    • Model.post_setup()
    • Model.set_element_size_of_group()
    • Model.set_mesh_size()
    • Model.show_geometry()
    • Model.split_model_part()
    • Model.synchronise_geometry()
    • Model.validate()
• stem.model_part module
  • BodyModelPart
    • BodyModelPart.get_element_name()
  • Material
  • ModelPart
    • ModelPart.get_element_name()
    • ModelPart.get_geometry_from_geo_data()
    • ModelPart.name
    • ModelPart.validate_input()
  • MovingLoadTypes
  • ProcessParameters
• stem.output module
  • GaussPointOutput
    • GaussPointOutput.BIOT_COEFFICIENT
    • GaussPointOutput.BULK_MODULUS_FLUID
    • GaussPointOutput.BULK_MODULUS_SOLID
    • GaussPointOutput.CAUCHY_STRESS_TENSOR
    • GaussPointOutput.CAUCHY_STRESS_VECTOR
    • GaussPointOutput.DENSITY_FLUID
    • GaussPointOutput.DENSITY_SOLID
    • GaussPointOutput.DYNAMIC_VISCOSITY
    • GaussPointOutput.ENGINEERING_STRAIN_TENSOR
    • GaussPointOutput.ENGINEERING_STRAIN_VECTOR
    • GaussPointOutput.FLUID_FLUX_VECTOR
    • GaussPointOutput.FORCE
    • GaussPointOutput.GREEN_LAGRANGE_STRAIN_TENSOR
    • GaussPointOutput.GREEN_LAGRANGE_STRAIN_VECTOR
    • GaussPointOutput.HYDRAULIC_HEAD
    • GaussPointOutput.MOMENT
    • GaussPointOutput.PERMEABILITY_XX
    • GaussPointOutput.PERMEABILITY_XY
    • GaussPointOutput.PERMEABILITY_YY
    • GaussPointOutput.PERMEABILITY_YZ
    • GaussPointOutput.PERMEABILITY_ZX
    • GaussPointOutput.PERMEABILITY_ZZ
    • GaussPointOutput.POISSON_RATIO
    • GaussPointOutput.POROSITY
    • GaussPointOutput.TOTAL_STRESS_TENSOR
    • GaussPointOutput.TOTAL_STRESS_VECTOR
    • GaussPointOutput.UMAT_PARAMETERS
    • GaussPointOutput.VON_MISES_STRESS
    • GaussPointOutput.YOUNG_MODULUS
  • GiDOutputParameters
    • GiDOutputParameters.file_format
    • GiDOutputParameters.file_label
    • GiDOutputParameters.gauss_point_results
    • GiDOutputParameters.nodal_results
    • GiDOutputParameters.output_control_type
    • GiDOutputParameters.output_interval
  • JsonOutputParameters
    • JsonOutputParameters.gauss_point_results
    • JsonOutputParameters.nodal_results
    • JsonOutputParameters.output_interval
  • NodalOutput
    • NodalOutput.ACCELERATION
    • NodalOutput.ACCELERATION_X
    • NodalOutput.ACCELERATION_Y
    • NodalOutput.ACCELERATION_Z
    • NodalOutput.CAUCHY_STRESS_VECTOR
    • NodalOutput.DISPLACEMENT
    • NodalOutput.DISPLACEMENT_X
    • NodalOutput.DISPLACEMENT_Y
    • NodalOutput.DISPLACEMENT_Z
    • NodalOutput.TOTAL_DISPLACEMENT
    • NodalOutput.TOTAL_DISPLACEMENT_X
    • NodalOutput.TOTAL_DISPLACEMENT_Y
    • NodalOutput.TOTAL_DISPLACEMENT_Z
    • NodalOutput.VELOCITY
    • NodalOutput.VELOCITY_X
    • NodalOutput.VELOCITY_Y
    • NodalOutput.VELOCITY_Z
    • NodalOutput.VOLUME_ACCELERATION
    • NodalOutput.VOLUME_ACCELERATION_X
    • NodalOutput.VOLUME_ACCELERATION_Y
    • NodalOutput.VOLUME_ACCELERATION_Z
    • NodalOutput.WATER_PRESSURE
  • Output
  • OutputParametersABC
  • VtkOutputParameters
    • VtkOutputParameters.file_format
    • VtkOutputParameters.gauss_point_results
    • VtkOutputParameters.nodal_results
    • VtkOutputParameters.output_control_type
    • VtkOutputParameters.output_interval
    • VtkOutputParameters.output_precision
  • detect_tensor_outputs()
  • detect_vector_in_tensor_outputs()
  • validate_gauss_point_output()
  • validate_nodal_point_output()
• stem.plot_utils module
  • PlotUtils
    • PlotUtils.create_geometry_figure()
• stem.soil_material module
  • FluidProperties
    • FluidProperties.BULK_MODULUS_FLUID
    • FluidProperties.DENSITY_FLUID
    • FluidProperties.DYNAMIC_VISCOSITY
  • LinearElasticSoil
    • LinearElasticSoil.POISSON_RATIO
    • LinearElasticSoil.YOUNG_MODULUS
  • OnePhaseSoil
    • OnePhaseSoil.BIOT_COEFFICIENT
    • OnePhaseSoil.BULK_MODULUS_SOLID
    • OnePhaseSoil.DENSITY_SOLID
    • OnePhaseSoil.IS_DRAINED
    • OnePhaseSoil.POROSITY
    • OnePhaseSoil.RAYLEIGH_K
    • OnePhaseSoil.RAYLEIGH_M
  • RetentionLawABC
  • SaturatedBelowPhreaticLevelLaw
    • SaturatedBelowPhreaticLevelLaw.RESIDUAL_SATURATION
    • SaturatedBelowPhreaticLevelLaw.SATURATED_SATURATION
  • SaturatedLaw
    • SaturatedLaw.SATURATED_SATURATION
  • SmallStrainUdsmLaw
    • SmallStrainUdsmLaw.IS_FORTRAN_UDSM
    • SmallStrainUdsmLaw.UDSM_NAME
    • SmallStrainUdsmLaw.UDSM_NUMBER
    • SmallStrainUdsmLaw.UDSM_PARAMETERS
  • SmallStrainUmatLaw
    • SmallStrainUmatLaw.IS_FORTRAN_UMAT
    • SmallStrainUmatLaw.STATE_VARIABLES
    • SmallStrainUmatLaw.UMAT_NAME
    • SmallStrainUmatLaw.UMAT_PARAMETERS
  • SoilConstitutiveLawABC
  • SoilFormulationParametersABC
    • SoilFormulationParametersABC.ndim
  • SoilMaterial
    • SoilMaterial.constitutive_law
    • SoilMaterial.fluid_properties
    • SoilMaterial.get_element_name()
    • SoilMaterial.get_property_in_material()
    • SoilMaterial.name
    • SoilMaterial.retention_parameters
    • SoilMaterial.soil_formulation
    • SoilMaterial.to_dict()
  • TwoPhaseSoil
    • TwoPhaseSoil.BIOT_COEFFICIENT
    • TwoPhaseSoil.BULK_MODULUS_SOLID
    • TwoPhaseSoil.DENSITY_SOLID
    • TwoPhaseSoil.PERMEABILITY_XX
    • TwoPhaseSoil.PERMEABILITY_XY
    • TwoPhaseSoil.PERMEABILITY_YY
    • TwoPhaseSoil.PERMEABILITY_YZ
    • TwoPhaseSoil.PERMEABILITY_ZX
    • TwoPhaseSoil.PERMEABILITY_ZZ
    • TwoPhaseSoil.POROSITY
    • TwoPhaseSoil.RAYLEIGH_K
    • TwoPhaseSoil.RAYLEIGH_M
  • VanGenuchtenLaw
    • VanGenuchtenLaw.MINIMUM_RELATIVE_PERMEABILITY
    • VanGenuchtenLaw.RESIDUAL_SATURATION
    • VanGenuchtenLaw.SATURATED_SATURATION
    • VanGenuchtenLaw.VAN_GENUCHTEN_AIR_ENTRY_PRESSURE
    • VanGenuchtenLaw.VAN_GENUCHTEN_GL
    • VanGenuchtenLaw.VAN_GENUCHTEN_GN
• stem.solver module
  • Amgcl
    • Amgcl.coarsening_type
    • Amgcl.krylov_type
    • Amgcl.max_iteration
    • Amgcl.preconditioner_type
    • Amgcl.scaling
    • Amgcl.smoother_type
    • Amgcl.solver_type
    • Amgcl.tolerance
  • AnalysisType
    • AnalysisType.GROUNDWATER_FLOW
    • AnalysisType.MECHANICAL
    • AnalysisType.MECHANICAL_GROUNDWATER_FLOW
  • ArcLengthStrategy
    • ArcLengthStrategy.desired_iterations
    • ArcLengthStrategy.max_iterations
    • ArcLengthStrategy.max_radius_factor
    • ArcLengthStrategy.min_iterations
    • ArcLengthStrategy.min_radius_factor
    • ArcLengthStrategy.number_cycles
    • ArcLengthStrategy.strategy_type
  • BackwardEulerScheme
    • BackwardEulerScheme.scheme_type
  • Cg
    • Cg.max_iteration
    • Cg.preconditioner_type
    • Cg.scaling
    • Cg.solver_type
    • Cg.tolerance
    • Cg.validate_settings()
  • ConvergenceCriteriaABC
    • ConvergenceCriteriaABC.convergence_criterion
  • DisplacementAndWaterPressureConvergenceCriteria
    • DisplacementAndWaterPressureConvergenceCriteria.convergence_criterion
    • DisplacementAndWaterPressureConvergenceCriteria.displacement_absolute_tolerance
    • DisplacementAndWaterPressureConvergenceCriteria.displacement_relative_tolerance
    • DisplacementAndWaterPressureConvergenceCriteria.water_pressure_absolute_tolerance
    • DisplacementAndWaterPressureConvergenceCriteria.water_pressure_relative_tolerance
  • DisplacementConvergenceCriteria
    • DisplacementConvergenceCriteria.convergence_criterion
    • DisplacementConvergenceCriteria.displacement_absolute_tolerance
    • DisplacementConvergenceCriteria.displacement_relative_tolerance
  • LineSearchStrategy
    • LineSearchStrategy.echo_level
    • LineSearchStrategy.first_alpha_value
    • LineSearchStrategy.line_search_tolerance
    • LineSearchStrategy.max_alpha
    • LineSearchStrategy.max_iterations
    • LineSearchStrategy.max_line_search_iterations
    • LineSearchStrategy.min_alpha
    • LineSearchStrategy.min_iterations
    • LineSearchStrategy.number_cycles
    • LineSearchStrategy.second_alpha_value
    • LineSearchStrategy.strategy_type
  • LinearNewtonRaphsonStrategy
    • LinearNewtonRaphsonStrategy.initialize_acceleration
    • LinearNewtonRaphsonStrategy.max_iterations
    • LinearNewtonRaphsonStrategy.min_iterations
    • LinearNewtonRaphsonStrategy.number_cycles
    • LinearNewtonRaphsonStrategy.strategy_type
  • LinearSolverSettingsABC
    • LinearSolverSettingsABC.solver_type
    • LinearSolverSettingsABC.validate_settings()
  • Lu
    • Lu.scaling
    • Lu.solver_type
  • NewmarkScheme
    • NewmarkScheme.newmark_beta
    • NewmarkScheme.newmark_gamma
    • NewmarkScheme.newmark_theta
    • NewmarkScheme.scheme_type
  • NewtonRaphsonStrategy
    • NewtonRaphsonStrategy.max_iterations
    • NewtonRaphsonStrategy.min_iterations
    • NewtonRaphsonStrategy.number_cycles
    • NewtonRaphsonStrategy.strategy_type
  • Problem
    • Problem.number_of_threads
    • Problem.problem_name
    • Problem.settings
  • ResidualConvergenceCriteria
    • ResidualConvergenceCriteria.convergence_criterion
    • ResidualConvergenceCriteria.residual_absolute_tolerance
    • ResidualConvergenceCriteria.residual_relative_tolerance
  • SchemeABC
    • SchemeABC.scheme_type
  • SolutionType
    • SolutionType.DYNAMIC
    • SolutionType.QUASI_STATIC
  • SolverSettings
    • SolverSettings.analysis_type
    • SolverSettings.are_mass_and_damping_constant
    • SolverSettings.calculate_stresses_on_nodes
    • SolverSettings.convergence_criteria
    • SolverSettings.echo_level
    • SolverSettings.is_stiffness_matrix_constant
    • SolverSettings.linear_solver_settings
    • SolverSettings.rayleigh_k
    • SolverSettings.rayleigh_m
    • SolverSettings.reset_displacements
    • SolverSettings.scheme
    • SolverSettings.solution_type
    • SolverSettings.strategy_type
    • SolverSettings.stress_initialisation_type
    • SolverSettings.time_integration
    • SolverSettings.validate_settings()
  • SparseCg
    • SparseCg.max_iteration
    • SparseCg.scaling
    • SparseCg.solver_type
    • SparseCg.tolerance
  • StaticScheme
    • StaticScheme.scheme_type
  • StrategyTypeABC
    • StrategyTypeABC.strategy_type
  • StressInitialisationType
    • StressInitialisationType.GRAVITY_LOADING
    • StressInitialisationType.K0_PROCEDURE
    • StressInitialisationType.NONE
  • TimeIntegration
    • TimeIntegration.delta_time
    • TimeIntegration.end_time
    • TimeIntegration.increase_factor
    • TimeIntegration.max_delta_time_factor
    • TimeIntegration.reduction_factor
    • TimeIntegration.start_time
  • WaterPressureConvergenceCriteria
    • WaterPressureConvergenceCriteria.convergence_criterion
    • WaterPressureConvergenceCriteria.water_pressure_absolute_tolerance
    • WaterPressureConvergenceCriteria.water_pressure_relative_tolerance
• stem.stem module
  • Stem
    • Stem.add_calculation_stage()
    • Stem.create_new_stage()
    • Stem.finalise()
    • Stem.run_calculation()
    • Stem.run_stage()
    • Stem.stages
    • Stem.validate_latest_stage()
    • Stem.write_all_input_files()
• stem.structural_material module
  • ElasticSpringDamper
    • ElasticSpringDamper.NODAL_DAMPING_COEFFICIENT
    • ElasticSpringDamper.NODAL_DISPLACEMENT_STIFFNESS
    • ElasticSpringDamper.NODAL_ROTATIONAL_DAMPING_COEFFICIENT
    • ElasticSpringDamper.NODAL_ROTATIONAL_STIFFNESS
    • ElasticSpringDamper.get_element_name()
  • EulerBeam
    • EulerBeam.CROSS_AREA
    • EulerBeam.DENSITY
    • EulerBeam.I22
    • EulerBeam.I33
    • EulerBeam.POISSON_RATIO
    • EulerBeam.RAYLEIGH_K
    • EulerBeam.RAYLEIGH_M
    • EulerBeam.TORSIONAL_INERTIA
    • EulerBeam.YOUNG_MODULUS
    • EulerBeam.get_element_name()
    • EulerBeam.ndim
  • NodalConcentrated
    • NodalConcentrated.NODAL_DAMPING_COEFFICIENT
    • NodalConcentrated.NODAL_DISPLACEMENT_STIFFNESS
    • NodalConcentrated.NODAL_MASS
    • NodalConcentrated.get_element_name()
  • StructuralMaterial
    • StructuralMaterial.get_element_name()
    • StructuralMaterial.get_property_in_material()
    • StructuralMaterial.material_parameters
    • StructuralMaterial.name
  • StructuralParametersABC
    • StructuralParametersABC.get_element_name()
• stem.table module
  • Table
    • Table.id
    • Table.interpolate_value_at_time()
    • Table.times
    • Table.values
• stem.utils module
  • NUMBER_TYPES
  • Utils
    • Utils.are_2d_coordinates_clockwise()
    • Utils.calculate_normal_unit_vector_to_line_on_xy_plane()
    • Utils.calculated_normal_unit_vector_to_plane()
    • Utils.chain_sequence()
    • Utils.check_dimensions()
    • Utils.check_lines_geometry_are_path()
    • Utils.check_ndim_nnodes_combinations()
    • Utils.create_box_tiny_expr()
    • Utils.create_sigmoid_tiny_expr()
    • Utils.find_first_three_non_collinear_points()
    • Utils.find_node_ids_close_to_geometry_nodes()
    • Utils.flip_node_order()
    • Utils.get_element_edges()
    • Utils.get_unique_objects()
    • Utils.is_collinear()
    • Utils.is_non_str_sequence()
    • Utils.is_point_aligned_and_between_any_of_points()
    • Utils.is_point_between_points()
    • Utils.is_point_coplanar_to_polygon()
    • Utils.is_polygon_planar()
    • Utils.is_volume_edge_defined_outwards()
    • Utils.merge()
    • Utils.replace_extensions()
    • Utils.validate_coordinates()
• stem.water_processes module
  • UniformWaterPressure
    • UniformWaterPressure.is_fixed
    • UniformWaterPressure.water_pressure
  • WaterProcessParametersABC