FourCIPP 1.1.0__py3-none-any.whl → 1.2.0__py3-none-any.whl

fourcipp/config/4C_metadata.yaml

@@ -1,5 +1,5 @@
 metadata:
-  commit_hash: aeb492d9ff89b399b9be6b6b8b06a984e88a58cc
+  commit_hash: 987236e3e7336a663348d19d2252027d4af7c780
   version: 2025.3.0-dev
   description_section_name: TITLE
 legacy_element_specs:
@@ -40996,6 +40996,7 @@ sections:
               choices:
                 - name: none
                 - name: penalty
+                - name: lagrange
             - name: PENALTY_PARAMETER
               type: double
               description: "Penalty parameter for beam-to-solid surface contact"
@@ -41154,6 +41155,7 @@ sections:
               choices:
                 - name: none
                 - name: penalty
+                - name: lagrange
             - name: COUPLING_TYPE
               type: enum
               description: "How the coupling constraints are formulated/"
@@ -41362,6 +41364,7 @@ sections:
               choices:
                 - name: none
                 - name: penalty
+                - name: lagrange
             - name: MORTAR_SHAPE_FUNCTION
               type: enum
               description: "Shape function for the mortar Lagrange-multipliers"
@@ -41372,6 +41375,15 @@ sections:
                 - name: line2
                 - name: line3
                 - name: line4
+            - name: LAGRANGE_FORMULATION
+              type: enum
+              description: "Type of employed Lagrange Formulation while using Lagrange Multipliers for constraint enforcement "
+              required: false
+              default: none
+              choices:
+                - name: none
+                - name: saddlepoint
+                - name: regularized
             - name: MORTAR_FOURIER_MODES
               type: int
               description: "Number of fourier modes to be used for cross-section mortar coupling"
@@ -211945,6 +211957,665 @@ sections:
               description: "tolerance for convergence check of outer iteration"
               required: false
               default: 1e-06
+    - name: reduced_dimensional_lung
+      type: group
+      required: false
+      specs:
+        - type: all_of
+          specs:
+            - name: dynamics
+              type: group
+              required: true
+              specs:
+                - type: all_of
+                  specs:
+                    - name: time_increment
+                      type: double
+                      description: "Time increment dt."
+                      required: true
+                    - name: number_of_steps
+                      type: int
+                      description: "Number of time steps."
+                      required: true
+                    - name: restart_every
+                      type: int
+                      description: "Increment for writing restart."
+                      required: false
+                      default: 1
+                    - name: results_every
+                      type: int
+                      description: "Increment for writing solution."
+                      required: false
+                      default: 1
+                    - name: linear_solver
+                      type: int
+                      description: "Number of linear solver used for reduced dimensional lung simulation."
+                      required: true
+            - name: lung_tree
+              type: group
+              description: Definition of the reduced dimensional lung tree including model definitions and parameters
+              required: true
+              specs:
+                - type: all_of
+                  specs:
+                    - name: element_type
+                      type: selection
+                      description: "Type of reduced lung elements."
+                      required: true
+                      choices:
+                        - name: constant
+                          spec:
+                            name: constant
+                            type: enum
+                            description: "Constant value for the field."
+                            required: true
+                            choices:
+                              - name: Airway
+                              - name: TerminalUnit
+                        - name: from_file
+                          spec:
+                            name: from_file
+                            type: path
+                            description: "Path to a file containing the input field data."
+                            required: true
+                        - name: field_reference
+                          spec:
+                            name: field_reference
+                            type: string
+                            description: "Refer to a globally defined field by a name."
+                            required: true
+                    - name: generation
+                      type: selection
+                      description: "Generation of the airway elements."
+                      required: true
+                      choices:
+                        - name: constant
+                          spec:
+                            name: constant
+                            type: int
+                            description: "Constant value for the field."
+                            required: true
+                        - name: from_file
+                          spec:
+                            name: from_file
+                            type: path
+                            description: "Path to a file containing the input field data."
+                            required: true
+                        - name: field_reference
+                          spec:
+                            name: field_reference
+                            type: string
+                            description: "Refer to a globally defined field by a name."
+                            required: true
+                    - name: airways
+                      type: group
+                      description: Definition of the airway model.
+                      required: true
+                      specs:
+                        - type: all_of
+                          specs:
+                            - name: radius
+                              type: selection
+                              description: "Radius of the Airway."
+                              required: true
+                              choices:
+                                - name: constant
+                                  spec:
+                                    name: constant
+                                    type: double
+                                    description: "Constant value for the field."
+                                    required: true
+                                - name: from_file
+                                  spec:
+                                    name: from_file
+                                    type: path
+                                    description: "Path to a file containing the input field data."
+                                    required: true
+                                - name: field_reference
+                                  spec:
+                                    name: field_reference
+                                    type: string
+                                    description: "Refer to a globally defined field by a name."
+                                    required: true
+                            - name: flow_model
+                              type: group
+                              description: Flow model of the airway.
+                              required: true
+                              specs:
+                                - type: all_of
+                                  specs:
+                                    - name: resistance_type
+                                      type: selection
+                                      description: "Type of resistance model for the airway."
+                                      required: true
+                                      choices:
+                                        - name: constant
+                                          spec:
+                                            name: constant
+                                            type: enum
+                                            description: "Constant value for the field."
+                                            required: true
+                                            choices:
+                                              - name: Linear
+                                              - name: NonLinear
+                                        - name: from_file
+                                          spec:
+                                            name: from_file
+                                            type: path
+                                            description: "Path to a file containing the input field data."
+                                            required: true
+                                        - name: field_reference
+                                          spec:
+                                            name: field_reference
+                                            type: string
+                                            description: "Refer to a globally defined field by a name."
+                                            required: true
+                                    - name: resistance_model
+                                      type: group
+                                      description: Definition of the airway resistance model
+                                      required: false
+                                      specs:
+                                        - type: all_of
+                                          specs:
+                                            - name: non_linear
+                                              type: group
+                                              description: Definition of the non-linear airway resistance model.
+                                              required: false
+                                              specs:
+                                                - type: all_of
+                                                  specs:
+                                                    - name: turbulence_factor_gamma
+                                                      type: selection
+                                                      description: "Van Ertbruggen's generation dependent turbulence factor defining turbulent onset."
+                                                      required: true
+                                                      choices:
+                                                        - name: constant
+                                                          spec:
+                                                            name: constant
+                                                            type: double
+                                                            description: "Constant value for the field."
+                                                            required: true
+                                                        - name: from_file
+                                                          spec:
+                                                            name: from_file
+                                                            type: path
+                                                            description: "Path to a file containing the input field data."
+                                                            required: true
+                                                        - name: field_reference
+                                                          spec:
+                                                            name: field_reference
+                                                            type: string
+                                                            description: "Refer to a globally defined field by a name."
+                                                            required: true
+                                    - name: include_inertia
+                                      type: selection
+                                      description: "Include inertial effects in the airway flow model."
+                                      required: true
+                                      choices:
+                                        - name: constant
+                                          spec:
+                                            name: constant
+                                            type: bool
+                                            description: "Constant value for the field."
+                                            required: true
+                                        - name: from_file
+                                          spec:
+                                            name: from_file
+                                            type: path
+                                            description: "Path to a file containing the input field data."
+                                            required: true
+                                        - name: field_reference
+                                          spec:
+                                            name: field_reference
+                                            type: string
+                                            description: "Refer to a globally defined field by a name."
+                                            required: true
+                            - name: wall_model_type
+                              type: selection
+                              description: "Type of wall model of the airway."
+                              required: true
+                              choices:
+                                - name: constant
+                                  spec:
+                                    name: constant
+                                    type: enum
+                                    description: "Constant value for the field."
+                                    required: true
+                                    choices:
+                                      - name: Rigid
+                                      - name: KelvinVoigt
+                                - name: from_file
+                                  spec:
+                                    name: from_file
+                                    type: path
+                                    description: "Path to a file containing the input field data."
+                                    required: true
+                                - name: field_reference
+                                  spec:
+                                    name: field_reference
+                                    type: string
+                                    description: "Refer to a globally defined field by a name."
+                                    required: true
+                            - name: wall_model
+                              type: group
+                              description: Wall model of the airway.
+                              required: false
+                              specs:
+                                - type: all_of
+                                  specs:
+                                    - name: kelvin_voigt
+                                      type: group
+                                      description: Kelvin-Voigt type airway wall model.
+                                      required: false
+                                      specs:
+                                        - type: all_of
+                                          specs:
+                                            - name: elasticity
+                                              type: group
+                                              description: Elasticity parameters of the airway wall.
+                                              required: false
+                                              specs:
+                                                - type: all_of
+                                                  specs:
+                                                    - name: wall_poisson_ratio
+                                                      type: selection
+                                                      description: "Poisson's ratio of the airway wall."
+                                                      required: true
+                                                      choices:
+                                                        - name: constant
+                                                          spec:
+                                                            name: constant
+                                                            type: double
+                                                            description: "Constant value for the field."
+                                                            required: true
+                                                        - name: from_file
+                                                          spec:
+                                                            name: from_file
+                                                            type: path
+                                                            description: "Path to a file containing the input field data."
+                                                            required: true
+                                                        - name: field_reference
+                                                          spec:
+                                                            name: field_reference
+                                                            type: string
+                                                            description: "Refer to a globally defined field by a name."
+                                                            required: true
+                                                    - name: wall_elasticity
+                                                      type: selection
+                                                      description: "Elasticity of the airway wall."
+                                                      required: true
+                                                      choices:
+                                                        - name: constant
+                                                          spec:
+                                                            name: constant
+                                                            type: double
+                                                            description: "Constant value for the field."
+                                                            required: true
+                                                        - name: from_file
+                                                          spec:
+                                                            name: from_file
+                                                            type: path
+                                                            description: "Path to a file containing the input field data."
+                                                            required: true
+                                                        - name: field_reference
+                                                          spec:
+                                                            name: field_reference
+                                                            type: string
+                                                            description: "Refer to a globally defined field by a name."
+                                                            required: true
+                                                    - name: diameter_over_wall_thickness
+                                                      type: selection
+                                                      description: "Ratio of diameter over wall thickness."
+                                                      required: true
+                                                      choices:
+                                                        - name: constant
+                                                          spec:
+                                                            name: constant
+                                                            type: double
+                                                            description: "Constant value for the field."
+                                                            required: true
+                                                        - name: from_file
+                                                          spec:
+                                                            name: from_file
+                                                            type: path
+                                                            description: "Path to a file containing the input field data."
+                                                            required: true
+                                                        - name: field_reference
+                                                          spec:
+                                                            name: field_reference
+                                                            type: string
+                                                            description: "Refer to a globally defined field by a name."
+                                                            required: true
+                                            - name: viscosity
+                                              type: group
+                                              description: Viscous parameters of the airway wall.
+                                              required: false
+                                              specs:
+                                                - type: all_of
+                                                  specs:
+                                                    - name: viscous_time_constant
+                                                      type: selection
+                                                      description: "Viscous time constant."
+                                                      required: true
+                                                      choices:
+                                                        - name: constant
+                                                          spec:
+                                                            name: constant
+                                                            type: double
+                                                            description: "Constant value for the field."
+                                                            required: true
+                                                        - name: from_file
+                                                          spec:
+                                                            name: from_file
+                                                            type: path
+                                                            description: "Path to a file containing the input field data."
+                                                            required: true
+                                                        - name: field_reference
+                                                          spec:
+                                                            name: field_reference
+                                                            type: string
+                                                            description: "Refer to a globally defined field by a name."
+                                                            required: true
+                                                    - name: viscous_phase_shift
+                                                      type: selection
+                                                      description: "Viscous phase shift."
+                                                      required: true
+                                                      choices:
+                                                        - name: constant
+                                                          spec:
+                                                            name: constant
+                                                            type: double
+                                                            description: "Constant value for the field."
+                                                            required: true
+                                                        - name: from_file
+                                                          spec:
+                                                            name: from_file
+                                                            type: path
+                                                            description: "Path to a file containing the input field data."
+                                                            required: true
+                                                        - name: field_reference
+                                                          spec:
+                                                            name: field_reference
+                                                            type: string
+                                                            description: "Refer to a globally defined field by a name."
+                                                            required: true
+                    - name: terminal_units
+                      type: group
+                      description: Terminal units.
+                      required: true
+                      specs:
+                        - type: all_of
+                          specs:
+                            - name: rheological_model
+                              type: group
+                              description: Rheological model of the terminal unit.
+                              required: true
+                              specs:
+                                - type: all_of
+                                  specs:
+                                    - name: rheological_model_type
+                                      type: selection
+                                      description: "Type of the rheological model."
+                                      required: true
+                                      choices:
+                                        - name: constant
+                                          spec:
+                                            name: constant
+                                            type: enum
+                                            description: "Constant value for the field."
+                                            required: true
+                                            choices:
+                                              - name: KelvinVoigt
+                                              - name: FourElementMaxwell
+                                        - name: from_file
+                                          spec:
+                                            name: from_file
+                                            type: path
+                                            description: "Path to a file containing the input field data."
+                                            required: true
+                                        - name: field_reference
+                                          spec:
+                                            name: field_reference
+                                            type: string
+                                            description: "Refer to a globally defined field by a name."
+                                            required: true
+                                    - name: kelvin_voigt
+                                      type: group
+                                      description: Kelvin-Voigt model of the terminal unit.
+                                      required: false
+                                      specs:
+                                        - type: all_of
+                                          specs:
+                                            - name: viscosity_kelvin_voigt_eta
+                                              type: selection
+                                              description: "Viscosity parameter (dashpot) of the terminal unit."
+                                              required: true
+                                              choices:
+                                                - name: constant
+                                                  spec:
+                                                    name: constant
+                                                    type: double
+                                                    description: "Constant value for the field."
+                                                    required: true
+                                                - name: from_file
+                                                  spec:
+                                                    name: from_file
+                                                    type: path
+                                                    description: "Path to a file containing the input field data."
+                                                    required: true
+                                                - name: field_reference
+                                                  spec:
+                                                    name: field_reference
+                                                    type: string
+                                                    description: "Refer to a globally defined field by a name."
+                                                    required: true
+                                    - name: 4_element_maxwell
+                                      type: group
+                                      description: 4-element Maxwell model of the terminal unit.
+                                      required: false
+                                      specs:
+                                        - type: all_of
+                                          specs:
+                                            - name: viscosity_kelvin_voigt_eta
+                                              type: selection
+                                              description: "Dashpot viscosity of the Kelvin-Voigt body of the terminal unit."
+                                              required: true
+                                              choices:
+                                                - name: constant
+                                                  spec:
+                                                    name: constant
+                                                    type: double
+                                                    description: "Constant value for the field."
+                                                    required: true
+                                                - name: from_file
+                                                  spec:
+                                                    name: from_file
+                                                    type: path
+                                                    description: "Path to a file containing the input field data."
+                                                    required: true
+                                                - name: field_reference
+                                                  spec:
+                                                    name: field_reference
+                                                    type: string
+                                                    description: "Refer to a globally defined field by a name."
+                                                    required: true
+                                            - name: viscosity_maxwell_eta_m
+                                              type: selection
+                                              description: "Dashpot viscosity of the Maxwell body of the terminal unit."
+                                              required: true
+                                              choices:
+                                                - name: constant
+                                                  spec:
+                                                    name: constant
+                                                    type: double
+                                                    description: "Constant value for the field."
+                                                    required: true
+                                                - name: from_file
+                                                  spec:
+                                                    name: from_file
+                                                    type: path
+                                                    description: "Path to a file containing the input field data."
+                                                    required: true
+                                                - name: field_reference
+                                                  spec:
+                                                    name: field_reference
+                                                    type: string
+                                                    description: "Refer to a globally defined field by a name."
+                                                    required: true
+                                            - name: elasticity_maxwell_e_m
+                                              type: selection
+                                              description: "Spring stiffness of the Maxwell body of the terminal unit."
+                                              required: true
+                                              choices:
+                                                - name: constant
+                                                  spec:
+                                                    name: constant
+                                                    type: double
+                                                    description: "Constant value for the field."
+                                                    required: true
+                                                - name: from_file
+                                                  spec:
+                                                    name: from_file
+                                                    type: path
+                                                    description: "Path to a file containing the input field data."
+                                                    required: true
+                                                - name: field_reference
+                                                  spec:
+                                                    name: field_reference
+                                                    type: string
+                                                    description: "Refer to a globally defined field by a name."
+                                                    required: true
+                            - name: elasticity_model
+                              type: group
+                              description: Elasticity model for the customizable spring of the rheological model.
+                              required: true
+                              specs:
+                                - type: all_of
+                                  specs:
+                                    - name: elasticity_model_type
+                                      type: selection
+                                      description: "Type of the elastic model."
+                                      required: true
+                                      choices:
+                                        - name: constant
+                                          spec:
+                                            name: constant
+                                            type: enum
+                                            description: "Constant value for the field."
+                                            required: true
+                                            choices:
+                                              - name: Linear
+                                              - name: Ogden
+                                        - name: from_file
+                                          spec:
+                                            name: from_file
+                                            type: path
+                                            description: "Path to a file containing the input field data."
+                                            required: true
+                                        - name: field_reference
+                                          spec:
+                                            name: field_reference
+                                            type: string
+                                            description: "Refer to a globally defined field by a name."
+                                            required: true
+                                    - name: linear
+                                      type: group
+                                      description: Linear elastic model in the rheological model of the terminal unit.
+                                      required: false
+                                      specs:
+                                        - type: all_of
+                                          specs:
+                                            - name: elasticity_e
+                                              type: selection
+                                              description: "Linear elastic stiffness of the terminal unit."
+                                              required: true
+                                              choices:
+                                                - name: constant
+                                                  spec:
+                                                    name: constant
+                                                    type: double
+                                                    description: "Constant value for the field."
+                                                    required: true
+                                                - name: from_file
+                                                  spec:
+                                                    name: from_file
+                                                    type: path
+                                                    description: "Path to a file containing the input field data."
+                                                    required: true
+                                                - name: field_reference
+                                                  spec:
+                                                    name: field_reference
+                                                    type: string
+                                                    description: "Refer to a globally defined field by a name."
+                                                    required: true
+                                    - name: ogden
+                                      type: group
+                                      description: Ogden type spring in the rheological model of the terminal unit.
+                                      required: false
+                                      specs:
+                                        - type: all_of
+                                          specs:
+                                            - name: ogden_parameter_kappa
+                                              type: selection
+                                              description: "Parameter Kappa in volumetric Ogden law."
+                                              required: true
+                                              choices:
+                                                - name: constant
+                                                  spec:
+                                                    name: constant
+                                                    type: double
+                                                    description: "Constant value for the field."
+                                                    required: true
+                                                - name: from_file
+                                                  spec:
+                                                    name: from_file
+                                                    type: path
+                                                    description: "Path to a file containing the input field data."
+                                                    required: true
+                                                - name: field_reference
+                                                  spec:
+                                                    name: field_reference
+                                                    type: string
+                                                    description: "Refer to a globally defined field by a name."
+                                                    required: true
+                                            - name: ogden_parameter_beta
+                                              type: selection
+                                              description: "Parameter Beta in volumetric Ogden law."
+                                              required: true
+                                              choices:
+                                                - name: constant
+                                                  spec:
+                                                    name: constant
+                                                    type: double
+                                                    description: "Constant value for the field."
+                                                    required: true
+                                                - name: from_file
+                                                  spec:
+                                                    name: from_file
+                                                    type: path
+                                                    description: "Path to a file containing the input field data."
+                                                    required: true
+                                                - name: field_reference
+                                                  spec:
+                                                    name: field_reference
+                                                    type: string
+                                                    description: "Refer to a globally defined field by a name."
+                                                    required: true
+            - name: air_properties
+              type: group
+              description: Air properties for the reduced dimensional lung simulation
+              required: true
+              specs:
+                - type: all_of
+                  specs:
+                    - name: dynamic_viscosity
+                      type: double
+                      description: "Dynamic viscosity of air in the reduced dimensional lung simulation."
+                      required: true
+                    - name: density
+                      type: double
+                      description: "Density of air in the reduced dimensional lung simulation."
+                      required: true
 legacy_string_sections:
   - STRUCTURE ELEMENTS
   - FLUID ELEMENTS