Clean up btb input params

[knarfnitram]

Description

For BEAMS_NEWGAP in #1426 and #1459 a discussion arrised, indicating that BEAMS_NEWGAP does not resemble a good variable name. This seems to be the case for more of the beam contact parameter from the file 4C_beaminteraction_beam_to_beam_contact_params.

Possible Solution and Definition of Done

• Identify and remove unused parameters from 4C_beaminteraction_beam_to_beam_contact_params after the deletion of the old beam contact framework
• Discuss which renaming of parameter list (at least remove BEAMS_ suffix)
• Create regex based python script to rename all variables and adapt all test cases
• Update beamme (https://github.com/beamme-py/beamme/blob/main/src/beamme/four_c/header_functions.py)

List of beam contact parameters

• BEAMS_BASICSTIFFGAP
• BEAMS_BTBLINEPENALTYPARAM -> LINE_PENALTY_PARAMETER
• BEAMS_BTBPENALTYPARAM -> POINT_PENALTY_PARAMETER
• BEAMS_ENDPOINTPENALTY -> ENDPOINT_PENALTY
• BEAMS_GAPSHIFTPARAM -> PENALTY_PARAMETER_SHIFT_GAP
• BEAMS_NEWGAP ->
• PREVIOUS_NORMAL_FOR_GAP
• ENHANCED_GAP_FUNCTION
• BEAMS_HISTORY_GAP_FUNCTION
• BEAMS_HISTORY_GAP
• BEAMS_ENHANCED_GAP_FUNCTION
• PREVENT_CROSSING_OF_BEAMS
• PREVENT_CROSSING_OF_BEAMS_WITH_HISTORY_GAP
• BEAMS_NUMINTEGRATIONINTERVAL -> NUM_INTEGRATION_INTERVALS
• BEAMS_PARSHIFTANGLE1 -> LOWER_SHIFT_ANGLE_LINE_CONTACT
• BEAMS_PARSHIFTANGLE2 -> UPPER_SHIFT_ANGLE_LINE_CONTACT
• BEAMS_PENALTYLAW -> PENALTY_LAW_TYPE
• BEAMS_PENREGPARAM_C0-> C0_REGULARIZATION_PARAMETER
• BEAMS_PENREGPARAM_F0 -> FORCE_REGULARIZATION_PARAMETER
• BEAMS_PENREGPARAM_G0 -> GAP_REGULARIZATION_PARAMETER
• BEAMS_PERPSHIFTANGLE1 -> LOWER_SHIFT_ANGLE_POINT_CONTACT
• BEAMS_PERPSHIFTANGLE2 -> UPPER_SHIFT_ANGLE_POINT_CONTACT
• BEAMS_SEGANGLE -> MAXIMUM_SEGMENTATION_ANGLE
• BEAMS_SEGCON -> ACTIVE_SUBSEGMENT_GENERATION

Currently blocked by

• Remove beamcontact #1175
• First clean up of parameters: Remove old beamcontact input parameters #1549
• Script to automatically update all the input files would be useful here.

Interested Parties

@davidrudlstorfer @isteinbrecher @maxfirmbach @mayrmt

[knarfnitram]

Since #1549 causes a breaking change in the input file, now (or never) would be good time to update the remaining parameters. Any objections regarding the suggested names?

[davidrudlstorfer]

@knarfnitram I would wait a little bit. We have one very big inconsistency that should be addressed.

Currently we have the section BEAM CONTACT (see #1549)

Additionally, in /inpar/4C_inpar_beaminteraction.cpp we set the section BEAM INTERACTION/BEAM TO BEAM CONTACT

In my opinion, these sections should be merged initially before renaming single parameters

Then all the sections are aligned => BEAM INTERACTION / BEAM TO ...

As a next step following #1549 I would move the BEAM CONTACT parameters into src/beaminteraction/src/contact and name them 4C_beaminteraction_contact_beam_to_beam_input.cpp/hpp as well as renaming the section to BEAM INTERACTION/BEAM TO BEAM CONTACT. What do you think?

FYI @isteinbrecher

[davidrudlstorfer]

@isteinbrecher @knarfnitram as already written in #1551 one proposal for the new layout could be

OLD LAYOUT

BEAM INTERACTION/BEAM TO BEAM CONTACT:
  BEAMS_SEGCON: true
  BEAMS_BTBPENALTYPARAM: 1000
  BEAMS_BTBLINEPENALTYPARAM: 4000
  BEAMS_PERPSHIFTANGLE1: 15
  BEAMS_PERPSHIFTANGLE2: 20
  BEAMS_PARSHIFTANGLE1: 15
  BEAMS_PARSHIFTANGLE2: 20
  BEAMS_SEGANGLE: 1
  BEAMS_NUMINTEGRATIONINTERVAL: 20
  BEAMS_PENALTYLAW: "LinPosQuadPen"
  BEAMS_PENREGPARAM_G0: 0.002
  BEAMS_PENREGPARAM_F0: 0
  BEAMS_PENREGPARAM_C0: 0
BEAM INTERACTION/BEAM TO BEAM CONTACT/RUNTIME VTK OUTPUT:
  VTK_OUTPUT_BEAM_CONTACT: true
  INTERVAL_STEPS: 1
  CONTACT_FORCES: true
  GAPS: true

NEW LAYOUT

beam_contact:
  active_subset_generation: true
  point_penalty_parameter: 1000
  line_penalty_parameter: 4000
  lower_shift_angle_point_contact: 15
  upper_shift_angle_point_contact: 20
  lower_shift_angle_line_contact: 15
  upper_shift_angle_line_contact: 20
  maximum_segmentation_angle: 1
  num_integration_intervals: 20
  penalty_law_type: "LinPosQuadPen"
  gap_regularization_parameter: 0.002
  force_regularization_parameter: 0
  c0_regularization_parameter: 0
  runtime_output:
    output: True
    interval_steps: 1
    contact_forces: True
    gaps: True

@knarfnitram additionally I would rename all parameters slightly differently. Note, that for example FourCIPP writes the parameteres in alphabetical order.

Therefore, it would make more sense to use shift_angle_point_contact_lower and shift_angle_point_contact_upper because then it is next to each other in the input file. If you put lower and upper in front the parameters never stay next to each other. The same holds for all other parameters.

[isteinbrecher]

@davidrudlstorfer sounds good to me. There are even more parameters where shuffling the naming can help improve ordering, e.g., penalty parameter, regularization_parameter, ... .

I would stay with uppercase for now, as this is the standard in beaminteraction, but I don't have a strong opinion on this.