beamme.four_c.beam_interaction_conditions

  1# The MIT License (MIT)
  2#
  3# Copyright (c) 2018-2025 BeamMe Authors
  4#
  5# Permission is hereby granted, free of charge, to any person obtaining a copy
  6# of this software and associated documentation files (the "Software"), to deal
  7# in the Software without restriction, including without limitation the rights
  8# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  9# copies of the Software, and to permit persons to whom the Software is
 10# furnished to do so, subject to the following conditions:
 11#
 12# The above copyright notice and this permission notice shall be included in
 13# all copies or substantial portions of the Software.
 14#
 15# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 16# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 17# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 18# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 19# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 20# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 21# THE SOFTWARE.
 22"""This file contains a function to add the beam interaction conditions for
 234C."""
 24
 25from typing import Optional as _Optional
 26
 27import beamme.core.conf as _conf
 28from beamme.core.boundary_condition import BoundaryCondition as _BoundaryCondition
 29from beamme.core.geometry_set import GeometrySet as _GeometrySet
 30from beamme.core.mesh import Mesh as _Mesh
 31
 32
 33def get_next_possible_id_for_boundary_condition(
 34    mesh: _Mesh,
 35    bc_type: _conf.BoundaryCondition,
 36    geometry_type: _conf.Geometry,
 37    condition_string: str,
 38) -> int:
 39    """Returns the next possible id, which can be used for a boundary condition
 40    based on all previous added boundary conditions within a mesh.
 41
 42    It returns the first ID which is not yet occupied within the existing boundary conditions
 43    w.r.t. to the given search_string and regex group index.
 44
 45    Args:
 46        mesh: Mesh containing already set boundary conditions.
 47        bc_type: Type of the boundary condition to be searched.
 48        geometry_type: Geometry type of the boundary condition.
 49        condition_string: String defining the condition ID tag.
 50
 51    Returns:
 52        id: Smallest available ID
 53    """
 54
 55    found_conditions = []
 56
 57    # loop through every possible geometry and find the conditions
 58    if (bc_type, geometry_type) in mesh.boundary_conditions:
 59        for bc_condition in mesh.boundary_conditions[(bc_type, geometry_type)]:
 60            found_conditions.append(bc_condition)
 61
 62    if not found_conditions:
 63        # return starting id, since no conditions of type has been added.
 64        return 0
 65    else:
 66        existing_ids = []
 67
 68        # compare string of each condition with input and store existing ids
 69        for bc in found_conditions:
 70            if condition_string in bc.data:
 71                existing_ids.append(bc.data[condition_string])
 72            else:
 73                raise KeyError(
 74                    f"The key {condition_string} is not in the data {bc.data}"
 75                )
 76
 77        # return lowest found id
 78        return min(set(range(len(existing_ids) + 1)) - set(existing_ids))
 79
 80
 81def add_beam_interaction_condition(
 82    mesh: _Mesh,
 83    geometry_set_1: _GeometrySet,
 84    geometry_set_2: _GeometrySet,
 85    bc_type: _conf.BoundaryCondition,
 86    *,
 87    id: _Optional[int] = None,
 88) -> int:
 89    """Adds a pair of beam interaction boundary conditions to the given mesh
 90    and estimates automatically the id of them based on all previously added
 91    boundary conditions of the mesh.
 92
 93    Args:
 94        mesh: Mesh to which the boundary conditions will be added.
 95        geometry_set_1: GeometrySet 1 for beam interaction boundary condition
 96        geometry_set_2: GeometrySet 2 for beam interaction boundary condition
 97        id: id of the two conditions
 98
 99    Returns:
100        id: Used id for the created condition.
101    """
102
103    condition_string = "COUPLING_ID"
104    if id is None:
105        id = get_next_possible_id_for_boundary_condition(
106            mesh,
107            bc_type,
108            geometry_set_1.geometry_type,
109            condition_string=condition_string,
110        )
111
112        id_2 = get_next_possible_id_for_boundary_condition(
113            mesh,
114            bc_type,
115            geometry_set_2.geometry_type,
116            condition_string=condition_string,
117        )
118
119        if not id == id_2:
120            raise ValueError(
121                f"The estimated IDs {id} and {id_2} do not match. Check Inputfile."
122            )
123
124    # Creates the two conditions with the same ID.
125    for geometry_set in [geometry_set_1, geometry_set_2]:
126        mesh.add(
127            _BoundaryCondition(
128                geometry_set, data={condition_string: id}, bc_type=bc_type
129            )
130        )
131
132    return id