Function_Block_Cooling_System_Model.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file        Function_Block_Cooling_System_Model.h
//! @author      ANVILEX GmbH
//! @version     V1.0
//! @date        09.03.2021
//! @brief       Functional block Cooling_system_model class header file.
//! @attention   No special attention requered.
//! @copyright   (C) 2015-2021 ANVILEX LLC
//!
//! Redistribution and use in source and binary forms, with or without
//! modification, are permitted provided that the following conditions are met:
//!
//! 1. Redistributions of source code must retain the above copyright notice,
//!    this list of conditions and the following disclaimer.
//!
//! 2. Redistributions in binary form must reproduce the above copyright notice,
//!    this list of conditions and the following disclaimer in the documentation
//!    and/or other materials provided with the distribution.
//!
//! 3. Neither the name of ANVILEX nor the names of its contributors may be
//!    used to endorse or promote products derived from this software without 
//!    specific prior written permission.
//!
//! THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
//! AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
//! IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
//! ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 
//! LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
//! CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
//! SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
//! INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
//! CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
//! ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
//! POSSIBILITY OF SUCH DAMAGE.
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Function_Block_Base.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
//! @brief Functional block class declaration
//------------------------------------------------------------------------------
 
class TFunction_Block_Cooling_System_Model : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public variables and methods
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Constructor and destructor methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TFunction_Block_Cooling_System_Model();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class desstructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TFunction_Block_Cooling_System_Model();
 
    //--------------------------------------------------------------------------
    // Function block data processing methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Functional block initialisation method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Functional block execution method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute();
 
    //--------------------------------------------------------------------------
    // Function block parameters
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block inputs
    //--------------------------------------------------------------------------
    
    //! @brief Power dissipated in the transistor 
    TBlock_Input_Connector object_f32_IGBT_Power;
    
    //! @brief Ambient temperature
    TBlock_Input_Connector object_f32_Ambient_Temperature;
    
    //! @brief Integration step of solver
    TBlock_Input_Connector object_f32_Integration_Step;
    
    //! @brief Heater control signal 
    TBlock_Input_Connector object_bool_LCS_Heater_Control;
    
    //! @brief Pump control signal 
    TBlock_Input_Connector object_bool_LCS_Pump_Control;
    
    //! @brief Heat exchanger fan control signal
    TBlock_Input_Connector object_bool_LCS_He_Fan_Control;
    
    //! @brief EMU heater fuse status
    TBlock_Input_Connector object_bool_EMU_Heater_Fuse_Status;
    
    //! @brief EMU pump fuse status
    TBlock_Input_Connector object_bool_EMU_Pump_Fuse_Status;
    
    //! @brief EMU heat exchanger fuse status
    TBlock_Input_Connector object_bool_EMU_Heat_Exchanger_Fuse_Status;
 
    //--------------------------------------------------------------------------
    // Function block outputs
    //--------------------------------------------------------------------------
    
    //! @brief Fan speed value
    TBlock_Output_Connector object_f32_Fan_Speed;
    
    //! @brief Water speed value
    TBlock_Output_Connector object_f32_Water_Speed;
    
    //! @brief Heater contactor status signal
    TBlock_Output_Connector object_bool_LCS_Heater_Contactor_Status;
    
    //! @brief Pump contactor status signal
    TBlock_Output_Connector object_bool_LCS_Pump_Contactor_Status;
    
    //! @brief Heat exchanger contactor status signal
    TBlock_Output_Connector object_bool_LCS_He_Fan_Contactor_Status;
    
    //! @brief First IGBT temperature value
    TBlock_Output_Connector object_f32_GSI_1_Temperature;
    
    //! @brief Second IGBT temperature value
    TBlock_Output_Connector object_f32_GSI_2_Temperature;
    
    //! @brief Third IGBT temperature value
    TBlock_Output_Connector object_f32_GSI_3_Temperature;
    
    //! @brief Fourth IGBT temperature value
    TBlock_Output_Connector object_f32_RSI_1_Temperature;
    
    //! @brief Fifth IGBT temperature value
    TBlock_Output_Connector object_f32_RSI_2_Temperature;
    
    //! @brief Sixth IGBT temperature value
    TBlock_Output_Connector object_f32_RSI_3_Temperature;
    
    //! @brief Seventh IGBT temperature value
    TBlock_Output_Connector object_f32_BALLAST_1_Temperature;
    
    //! @brief Eighth IGBT temperature value
    TBlock_Output_Connector object_f32_BALLAST_2_Temperature;
    
    //! @brief Inlet temperature value
    TBlock_Output_Connector object_f32_LCS_Inlet_Temperature;
    
    //! @brief Outlet temperature value
    TBlock_Output_Connector object_f32_LCS_Outlet_Temperature;
    
    //! @brief Inlet pressure value
    TBlock_Output_Connector object_f32_LCS_Inlet_Pressure;
    
    //! @brief Outlet pressure value
    TBlock_Output_Connector object_f32_LCS_Outlet_Pressure;
    
    //! @brief Water mass flow value
    TBlock_Output_Connector object_f32_LCS_Water_Mass_Flow;
    
    //! @brief Grid side inductor temperature
    TBlock_Output_Connector object_f32_INDUCTOR_GSI_Temperature;
    
    //! @brief Rotor side inductor temperature
    TBlock_Output_Connector object_f32_INDUCTOR_RSI_Temperature;
      
 
  //----------------------------------------------------------------------------
  // Protected variables and methods
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private variables and methods
  //----------------------------------------------------------------------------
 
  private:
  
  //----------------------------------------------------------------------------
  // Private methods
  //----------------------------------------------------------------------------
 
  //!---------------------------------------------------------------------------
  //! @brief     Switches the state of the heater depending on the control signal.
  //! @note      None
  //! @param     [in] Heater_Control_status - The state of the heater control signal
  //!            [in] u32_Timestamp_On - Turn-on delay timer
  //!            [in] u32_Timestamp_Off - Turn-off delay timer
  //! @return    None
  //! \par       Override
  //!            Not allowed 
  //! @attention None
  //----------------------------------------------------------------------------
  
  void Heater_State_Changer(BOOL Heater_Control_status, U32 &u32_Timestamp_On, U32 &u32_Timestamp_Off);
  
  //!---------------------------------------------------------------------------
  //! @brief     Switches the state of the pump depending on the control signal.
  //! @note      None
  //! @param     [in] Pump_Control_status - The state of the pump control signal
  //!            [in] u32_Timestamp_On - Turn-on delay timer
  //!            [in] u32_Timestamp_Off - Turn-off delay timer
  //! @return    None
  //! \par       Override
  //!            Not allowed 
  //! @attention None
  //----------------------------------------------------------------------------
  
  void Pump_State_Changer(BOOL Pump_Control_status, U32 &u32_Timestamp_On, U32 &u32_Timestamp_Off);
  
  //!---------------------------------------------------------------------------
  //! @brief     Switches the state of the fan depending on the control signal.
  //! @note      None
  //! @param     [in] He_Fan_Control_Status - The state of the fan control signal
  //!            [in] u32_Timestamp_On - Turn-on delay timer
  //!            [in] u32_Timestamp_Off - Turn-off delay timer
  //! @return    None
  //! \par       Override
  //!            Not allowed 
  //! @attention None
  //----------------------------------------------------------------------------
  
  void He_Fan_State_Changer(BOOL He_Fan_Control_Status, U32 &u32_Timestamp_On, U32 &u32_Timestamp_Off);
  
  //!---------------------------------------------------------------------------
  //! @brief     Return the value of the kinematic coefficient of air viscosity.
  //! @note      None
  //! @param     [in] Air_temperature - The value of ambient temperature
  //! @return    F64 - Return value of the kinematic coefficient of air viscosity
  //! \par       Override
  //!            Not allowed 
  //! @attention None
  //----------------------------------------------------------------------------
  
  F64 nu_air(F64 &Air_temperature);
  
  //!---------------------------------------------------------------------------
  //! @brief     Return the value of the coefficient of thermal conductivity of air.
  //! @note      None
  //! @param     [in] Air_temperature - The value of ambient temperature
  //! @return    F64 - Return value of the coefficient of thermal conductivity of air
  //! \par       Override
  //!            Not allowed 
  //! @attention None
  //----------------------------------------------------------------------------
  
  F64 lambda_air(F64 &Air_temperature);
  
  //!---------------------------------------------------------------------------
  //! @brief     Return the value of the kinematic coefficient of water viscosity.
  //! @note      None
  //! @param     [in] Water_temperature - The value of water temperature
  //! @return    F64 - Return value of the kinematic coefficient of water viscosity
  //! \par       Override
  //!            Not allowed 
  //! @attention None
  //----------------------------------------------------------------------------
  
  F64 nu_water(F64 &Water_temperature);
  
  //!---------------------------------------------------------------------------
  //! @brief     Return the value of the coefficient of thermal conductivity of water.
  //! @note      None
  //! @param     [in] Water_temperature - The value of water temperature
  //! @return    F64 - Return value of the coefficient of thermal conductivity of water
  //! \par       Override
  //!            Not allowed 
  //! @attention None
  //----------------------------------------------------------------------------
  
  F64 lambda_water(F64 &Water_temperature);
  
  //----------------------------------------------------------------------------
  // Private variables
  //----------------------------------------------------------------------------
  
  //----------------------------------------------------------------------------
  // Global variables
  //----------------------------------------------------------------------------
 
  //! @brief Pi
  F64 pi;
  
  //----------------------------------------------------------------------------
  // Structures
  //----------------------------------------------------------------------------
  
  //! @brief General structure of properties of substances 
  typedef struct 
  {
 
    //! @brief Mass of matter (m), [kg] 
    F32 F32_Mass;
 
    //! @brief Density of matter (ro), [kg/m^3]
    F32 F32_Density;
 
    //! @brief Area of matter (S), [m^2]
    F32 F32_Area[2];
 
    //! @brief Volume of matter (V), [m^3]
    F32 F32_Volume;
 
    //! @brief Velosity of of movement of matter (w), [m/s] 
    F32 F32_Velocity;
 
    //! @brief Initial value of temperature of matter (T), [°C]
    F64 F64_Temperature;
 
    //! @brief Initial value of temperature increment of matter (T), [°C]
    F64 F64_Delta_Temperature;
 
    //! @brief Specific heat capacity of matter (c), [J/(kg*°C)]
    F32 F32_Specific_Heat_Capacity;
 
    //! @brief Kinematic viscosity coefficient of matter (nu), [m^2/s]
    F32 F32_Kinematic_Viscosity_Coefficient;
 
    //! @brief Dynamic viscosity coefficient of matter (eta), [P*s]
    F32 F32_Dynamic_Viscosity_Coefficient;
 
    //! @brief Heat transfer coefficient (a), [W/(m^2 * °C)]
    F32 F32_Heat_Transfer_Coefficient;
 
    //! @brief Heat capacity of matter (C), [J/°C]
    F32 F32_Heat_Capacity;
 
    //! @brief Coefficient of thermal conductivity of matter (lambda), [W/(m*°C)]
    F32 F32_Coefficient_Of_Thermal_Conductivity;
 
    //! @brief Heat flow path length (d), [m]
    F32 F32_Heat_Flow_Path_Length[2];
 
  } Properties;
  
  //----------------------------------------------------------------------------
  // Matters
  //----------------------------------------------------------------------------
 
  //! @brief Variable responsible for ambience properties
  Properties Air;
  
  //! @brief Variable responsible for water properties
  Properties Water;
 
  //! @brief Variable responsible for power modules properties
  volatile Properties Ferrum_IGBT;
 
  //! @brief Variable responsible for the first inductor heatsink properties
  Properties Aluminium_Inductor_Heatsink_1;
 
  //! @brief Variable responsible for the second inductor heatsink properties
  Properties Aluminium_Inductor_Heatsink_2;
  
  //----------------------------------------------------------------------------
  // Water flow properties
  //----------------------------------------------------------------------------
  
  //! @brief Water speed
  F32 f32_Water_Speed;
  
  //! @brief Water speed when pump is on
  F32 f32_Water_Speed_Active;
  
  //! @brief Some small constant value of the fluid flow rate 
  F32 f32_Constant_Water_Flow;
  
  //----------------------------------------------------------------------------
  // Fan properties
  //----------------------------------------------------------------------------
  
  //! @brief Fan-cooled system area, [m^2]
  F32 ARIA_2;                                       
  
  //! @brief Fan diameter, [m]
  F32 FAN_D;                                        
  
  //! @brief Fan-cooled system length, [m]
  F32 FC_L;             
 
  //! @brief Fan speed
  F32 f32_Fan_Speed;
  
  //! @brief Fan speed when fan is on
  F32 f32_Fan_Speed_Active;
  
  //! @brief Some small constant air velocity  
  F32 f32_Constant_Fan_Speed;
  
  //----------------------------------------------------------------------------
  // Pipeline  properties
  //----------------------------------------------------------------------------
  
  //! @brief Diameter of the tube
  F32 F32_Power_Modules_Tube_Diameter;           
 
  //! @brief Diameter of the tube in inductor heatsink
  F32 F32_Inductor_Heatsink_Tube_Diameter;
 
  //! @brief Cross-sectional area of the tube
  F32 F32_Tube_Area; 
  
  //! @brief Inlet pressure normal value
  F32 Pin_value;
  
  //! @brief Outlet pressure normal value
  F32 Pout_value;
  
  //! @brief Variable that sets the rise time of the pressure sensor signal 
  F32 Tau;
  
  //----------------------------------------------------------------------------
  // Inductor  properties
  //----------------------------------------------------------------------------
  
  //! @brief Power dissipated in inductor
  F32 P_Inductor;
  
  //----------------------------------------------------------------------------
  // Variables for storing calculation results
  //----------------------------------------------------------------------------
 
  //! @brief Variable for storing the value of inlet pressure, [bar]
  F32 Pin;
  
  //! @brief Variable for storing the value of outlet pressure, [bar]
  F32 Pout;
  
  //----------------------------------------------------------------------------
  // Timers
  //----------------------------------------------------------------------------
  
  //! @brief Variable for heater status delay
  U32 u32_Timestamp_Heater_On;
  
  //! @brief Variable for heater status delay
  U32 u32_Timestamp_Heater_Off;
  
  //! @brief Variable for pump status delay
  U32 u32_Timestamp_Pump_On;
  
  //! @brief Variable for pump status delay
  U32 u32_Timestamp_Pump_Off;
  
  //! @brief Variable for fan status delay
  U32 u32_Timestamp_Fan_On;
  
  //! @brief Variable for fan status delay
  U32 u32_Timestamp_Fan_Off;
  
  //! @brief Variable for storing the heater state
  BOOL bool_Heater_State; 
   
  //! @brief Variable for storing the pump state
  BOOL bool_Pump_State;
  
  //! @brief Variable for storing fan state
  BOOL bool_Fan_State;
  
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------