DipoleMagneticFieldModel.h

Go to the documentation of this file.

/******************************************************************************
* Copyright (c) ATTX INC 2025. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX, INC. The Software is 
* furnished under a license agreement between ATTX and the user organization 
* and may be used or copied only in accordance with the terms of the agreement.
* Refer to 'license/attx_license.adoc' for standard license terms.
*
* EXPORT CONTROL NOTICE: THIS SOFTWARE MAY INCLUDE CONTENT CONTROLLED UNDER THE
* INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) OR THE EXPORT ADMINISTRATION 
* REGULATIONS (EAR99). No part of the Software may be used, reproduced, or 
* transmitted in any form or by any means, for any purpose, without the express 
* written permission of ATTX, INC.
******************************************************************************/
/*
Dipole magnetic field model header file
 
Author: James Tabony
*/
/*
Metadata for MS GUI:
imdata = {"exclude" : True}
*/
 
#ifndef MODELS_ENVIRONMENT_DIPOLE_MAGNETIC_FIELD_MODEL_H 
#define MODELS_ENVIRONMENT_DIPOLE_MAGNETIC_FIELD_MODEL_H
 
#include "frames/Body.h"
#include "frames/frameutils.h"
#include "simulation/Model.h"
#include "constants/planetdefaults.h"
 
namespace warptwin {

    MODEL(DipoleMagneticFieldModel)
    public:
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
            SIGNAL(mag_north_colat,         double,                 0.0)
            SIGNAL(mag_north_lon,           double,                 0.0)
            SIGNAL(dipole_magnitude,        double,                 30034)
            SIGNAL(r_planet_equitorial,     double,                 warpos::earth_wgs84.eq_radius)
            SIGNAL(planet_frame_rotating,   Frame*,                nullptr)
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
            SIGNAL(pos_obj_planet__PCR,     CartesianVector3,      CartesianVector3({0.0, 0.0, 0.0}))
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS
            SIGNAL(mag_field_obj__PCR,      CartesianVector3,      CartesianVector3({0.0, 0.0, 0.0}))
        END_OUTPUTS
 
    protected:
        // Execute in protected
        int16 start() override;
        int16 execute() override;
 
        // Internal variable for error handling
        int _err;
 
        // Temporary vectors and variables to carry out our calculations
        CartesianVector3 _mag_dipole__PCR; // Magnetic dipole vector in planet centered rotating coordinates
        CartesianVector3 _mag_field__PCR;  // Magnetic field vector in planet centered rotating coordinates
 
        // Internal variables for scaling factora
        double _scaling_factor;
 
    };
 
}
 
#endif