"""
Defines the FreeGSNKE machine object, which inherits from the FreeGS4E machine object.
Copyright 2025 UKAEA, UKRI-STFC, and The Authors, as per the COPYRIGHT and README files.
This file is part of FreeGSNKE.
FreeGSNKE is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
FreeGSNKE is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
You should have received a copy of the GNU Lesser General Public License
along with FreeGSNKE. If not, see <http://www.gnu.org/licenses/>.
"""
import freegs4e
[docs]
class Machine(freegs4e.machine.Machine):
"""Same as freegs4e.machine.Machine.
It can have an additional freegs4e.machine.Wall object which specifies the limiter's properties.
"""
[docs]
def __init__(self, coils, wall=None, limiter=None):
"""Instantiates the Machine, same as freegs4e.machine.Machine.
Parameters
----------
coils : FreeGS4E coils[(label, Coil|Circuit|Solenoid]
List of coils
wall : FreeGS4E machine.Wall object
It is only used to display the wall in plots.
limiter : FreeGS4E machine.Wall object
This is the limiter. Used to define limiter plasma configurations.
"""
super().__init__(coils, wall)
self.limiter = limiter