Generic_Cooling_Model.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      Generic_Cooling_Model.h
//! @brief     Cooling model generic class header file.
//! @copyright (C) 2015-2021 ANVILEX LLC
//! @attention No special attention requered.
//!            $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Common/Generic_Cooling_Model.h $
//!            $Revision: 0 $
//!            $Date: 2021-05-07 02:16:27 +0500 (Пт, 07 Мая 2021) $
//!            $Author: sorokin $
//
// Copyright(C) 2004-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.
//
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Defines.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Global defines
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Global macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class declaration
//------------------------------------------------------------------------------
 
//! @brief Cooling system generic model class
class TGeneric_Cooling_Model
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //! @dotfile   TGeneric_Cooling_Model__TGeneric_Cooling_Model.dt
    //--------------------------------------------------------------------------
 
    TGeneric_Cooling_Model();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class desstructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //! @dotfile   TGeneric_Cooling_Model___TGeneric_Cooling_Model.dt
    //--------------------------------------------------------------------------
 
    ~TGeneric_Cooling_Model();
    
    //!-------------------------------------------------------------------------
    //! @brief     Class initialisation method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! @dotfile   TGeneric_Cooling_Model__Init.dt
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
 
    //!---------------------------------------------------------------------------
    //! @brief     Member function that returns the value of the cabinet temperature.
    //! @note      None
    //! @param     -
    //! @return    F32 - Value of the cabinet temperature.
    //! \par       Override
    //!            Not allowed 
    //! @attention None
    //! @dotfile   TGeneric_Cooling_Model__Get_Cabinet_Temperature.dt
    //----------------------------------------------------------------------------
    
    F32 f32_Get_Cabinet_Temperature();
 
    //--------------------------------------------------------------------------
    // Model input data
    //--------------------------------------------------------------------------
  
    //! @brief Body surface area exposed to radiant heat transfer, [m^2]
    F32 f32_Area = (F32)0.0f;
    
    //! @brief Body Volume, [m^3]
    F32 f32_Volume = (F32)0.0f;
    
    //! @brief Specific thermal conductivity of a coolant, [J/(kg*°C)]
    F32 f32_Specific_Thermal_Conductivity = (F32)0.0f;
    
    //! @brief Heat loss power in the body, [W] 
    F32 f32_Power_Loss = (F32)0.0f;
    
    //! @brief Ambient temperature, [°C] 
    F32 f32_Ambient_Temperature = (F32)0.0f;
    
    //! @brief Fan curve proportional factor, [-] 
    F32 f32_k_fan = (F32)0.0f;
    
    //! @brief Filling factor of the volume with the coolant, [-] 
    F32 f32_b_volume = (F32)0.0f;
    
    //! @brief Density of a coolant, [kg/(m^3)] 
    F32 f32_Coolant_Density = (F32)0.0f;
  
    //! @brief Emissivity factor of an emitting surface, [-] 
    F32 f32_Emissivity_Factor = (F32)0.0f;
    
    //----------------------------------------------------------------------------
    // Generic properties
    //----------------------------------------------------------------------------  
    
    //! @brief Integration step, [s] 
    F32 f32_h = (F32)0.0f;
      
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
  
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //----------------------------------------------------------------------------
    // Private methods
    //----------------------------------------------------------------------------
 
    //!---------------------------------------------------------------------------
    //! @brief     Member function that returns the value of the heat transfer coefficient from a surface.
    //! @note      None
    //! @param     [in] &Ambient_Temperature - Pointer to a variable storing the value of the ambient temperature
    //!            [in] &Coolant_Temperature - Pointer to a variable storing the temperature of the coolant
    //! @return    F32 - Value of the heat transfer coefficient from an emitting surface.
    //! \par       Override
    //!            Not allowed 
    //! @attention None
    //! @dotfile   TGeneric_Cooling_Model__Heat_Transfer_Coefficient.dt
    //----------------------------------------------------------------------------
    
    F32 Heat_Transfer_Coefficient( F32 &Ambient_Temperature, F32 &Coolant_Temperature );
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
    //! @brief Coolant temperature, [°C]
    F32 f32_Coolant_Temperature = (F32)0.0f;
 
    //! @brief Volume filled with coolant, [m^3] 
    F32 f32_Effective_Volume = (F32)0.0f;
  
    //! @brief Mass of the coolant, [kg]
    F32 f32_Coolant_Mass = (F32)0.0f;
  
    //! @brief Thermal conductivity of the coolant, [J/°C]
    F32 f32_Coolant_Thermal_Conductivity = (F32)0.0f;
  
    //! @brief Increase in coolant temperature, [°C] 
    F32 f32_Delta_T = (F32)1.0f;
     
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------