nose_cone.py

import logging

from .._helpers import _dict_to_string

logger = logging.getLogger(__name__)


def search_nosecone(bs, elements=None, rocket_radius=None, just_radius=False):
    """Search for the nosecone in the bs and return the settings as a dict.

    Parameters
    ----------
    bs : bs4.BeautifulSoup
        The BeautifulSoup object of the .ork file.
    elements : dict
        Dictionary with the elements of the rocket.
    rocket_radius : float
        The radius of the rocket.
    just_radius : bool
        If True, returns only the radius of the nosecone.

    Returns
    -------
    settings : dict
        Dictionary with the settings for the nosecone.
    """
    settings = {}
    nosecone = bs.find("nosecone")  # TODO: allow for multiple nosecones
    name = nosecone.find("name").text if nosecone else "nosecone"

    if not nosecone:
        nosecones = list(
            filter(
                lambda x: x.find("name").text == "Nosecone", bs.find_all("transition")
            )
        )
        if len(nosecones) == 0:
            logger.info("Could not fetch a nosecone")
            return settings
        if len(nosecones) > 1:
            logger.info("Multiple nosecones found, using only the first one")
        nosecone = nosecones[0]  # only the first nosecone is considered

    length = float(nosecone.find("length").text)
    kind = nosecone.find("shape").text
    base_radius = nosecone.find("aftradius").text
    try:
        base_radius = float(base_radius)
    except ValueError:
        if "auto" in base_radius:
            # TODO: this is a temporary fix, we should look to the next component radius
            base_radius = rocket_radius

    # TODO: this is for specific use in the get_rocket_radius() function, given that the
    # search_nosecone is changed, the get_rocket_radius function must be re-evaluated
    if just_radius:
        return base_radius  # return nosecone radius to the get_rocket_radius function

    def get_position(name, length):
        count = 0
        position = None
        # defaults to case insensitive
        lower_name = name.lower()
        for element in elements.values():
            if element["name"].lower() == lower_name and element["length"] == length:
                count += 1
                position = element["position"]
        if count > 1:
            logger.warning(
                "Multiple nosecones with the same name and length, "
                "using the last one found."
            )
        elif count == 0:
            logger.error(
                "No element with the name '%s' and length '%f' was found",
                name,
                length,
            )
        return position

    logger.info("Collected the dimensions of the nosecone: length, shape and position.")

    if kind == "haack":
        logger.info("Nosecone is a haack nosecone, searching for the shape parameter")

        shape_parameter = float(nosecone.find("shapeparameter").text)
        kind = "Von Karman" if shape_parameter == 0.0 else "lvhaack"
        settings.update({"noseShapeParameter": shape_parameter})
        logger.info("Shape parameter of the nosecone: %s", shape_parameter)

    settings = {
        "name": name,
        "kind": kind,
        "length": length,
        "base_radius": base_radius,
        "position": get_position(name, length),
    }
    logger.info("Nosecone setting defined:\n %s", _dict_to_string(settings, indent=23))
    return settings