Source code for ansys.dyna.core.run.base_runner

# Copyright (C) 2021 - 2024 ANSYS, Inc. and/or its affiliates.
# SPDX-License-Identifier: MIT
#
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

"""Base runner class."""

from ansys.dyna.core.run.options import MemoryUnit, MpiOption, Precision



[docs]
class BaseRunner:
    def __init__(self, **kwargs):
        # TODO - split mpi option into precision?

[docs]
        self.mpi_option = kwargs.get("mpi_option", MpiOption.SMP)


[docs]
        self.ncpu = kwargs.get("ncpu", 1)


[docs]
        self.memory = kwargs.get("memory", 20)


[docs]
        self.memory_unit = kwargs.get("memory_unit", MemoryUnit.MB)


[docs]
        self.precision = kwargs.get("precision", Precision.DOUBLE)



[docs]
    def get_memory_string(self) -> str:
        unit = {MemoryUnit.MB: "m", MemoryUnit.GB: "G"}[self.memory_unit]
        return f"{self.memory}{unit}"