symcad.parts.fairing

 1#!/usr/bin/env python3
 2# Copyright (C) 2022, Will Hedgecock
 3#
 4# This program is free software: you can redistribute it and/or modify
 5# it under the terms of the GNU General Public License as published by
 6# the Free Software Foundation, either version 3 of the License, or
 7# (at your option) any later version.
 8#
 9# This program is distributed in the hope that it will be useful,
10# but WITHOUT ANY WARRANTY; without even the implied warranty of
11# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12# GNU General Public License for more details.
13#
14# You should have received a copy of the GNU General Public License
15# along with this program.  If not, see <http://www.gnu.org/licenses/>.
16
17from __future__ import annotations
18from ...core.SymPart import SymPart
19from typing import Callable, Union
20from ...core.ML import NeuralNet
21import abc, os
22
23class FairingShape(SymPart, metaclass=abc.ABCMeta):
24   """Base class from which all fairing shapes should derive."""
25
26   def __init__(self, identifier: str,
27                      cad_representation: Union[str, Callable],
28                      properties_model: Union[str, NeuralNet, None],
29                      material_density_kg_m3: float) -> None:
30      """Initializes a fairing `SymPart`.
31
32      Parameters
33      ----------
34      identifier : `str`
35         Unique, identifying name for the `FairingShape`.
36      cad_representation : `Union[str, Callable]`
37         Either the path to a representative CAD model for the given `FairingShape` or a
38         callable method that can create such a model.
39      properties_model : `Union[str, NeuralNet, None]`
40         Path to or instance of a neural network that may be evaluated to obtain the underlying
41         geometric properties for the given `FairingShape`.
42      material_density_kg_m3 : `float`
43         Uniform material density in `kg/m^3` to be used in mass property calculations.
44      """
45      super().__init__(identifier,
46                       os.path.join('fairing', cad_representation)
47                          if isinstance(cad_representation, str) else
48                       cad_representation,
49                       os.path.join('fairing', properties_model)
50                          if properties_model and isinstance(properties_model, str) else
51                       properties_model,
52                       material_density_kg_m3)
53
54from .CylinderWithConicalEnds import CylinderWithConicalEnds