DomainDiagnosticData.H

Go to the documentation of this file.

#ifdef CH_LANG_CC
/*
*      _______              __
*     / ___/ /  ___  __ _  / /  ___
*    / /__/ _ \/ _ \/  V \/ _ \/ _ \
*    \___/_//_/\___/_/_/_/_.__/\___/
*    Please refer to Copyright.txt, in Chombo's root directory.
*/
#endif

#ifndef DOMAIN_DIAGNOSTIC_DATA_H
#define DOMAIN_DIAGNOSTIC_DATA_H

#include "CH_HDF5.H"
#include "Vector.H"
#include "LevelSigmaCS.H"
#include "ParmParse.H"

#include "NamespaceHeader.H"


class AmrIce;

#define HDF5_SUBGROUP_NAME "bisicles_domain_diagnostic_data"
#define CFIO_DIAGNOSTIC_TIME_NAME "time"

#define CFIO_DIAGNOSTIC_ICE_VOLUME_SHORT_NAME "lim"
#define CFIO_DIAGNOSTIC_ICE_VAF_SHORT_NAME "limnsw"
#define CFIO_DIAGNOSTIC_GROUNDED_ICE_AREA_SHORT_NAME "iareagr"
#define CFIO_DIAGNOSTIC_FLOATING_ICE_AREA_SHORT_NAME "iareafl"
#define CFIO_DIAGNOSTIC_UPPER_SURFACE_FLUX_SHORT_NAME "tendacabf"
#define CFIO_DIAGNOSTIC_LOWER_SURFACE_FLUX_SHORT_NAME "tendlibmassbf"
#define CFIO_DIAGNOSTIC_LOWER_SURFACE_FLOATING_ICE_FLUX_SHORT_NAME "tendlibmassbffl"
#define CFIO_DIAGNOSTIC_CALVING_FLUX_SHORT_NAME "tendlicalvf"
#define CFIO_DIAGNOSTIC_ICE_FRONT_CALVING_AND_MELTING_SHORT_NAME "tendlifmassbf"

#define CFIO_DIAGNOSTIC_ICE_VOLUME_CF_NAME "land_ice_mass"
#define CFIO_DIAGNOSTIC_ICE_VAF_CF_NAME "land_ice_mass_not_displacing_sea_water"
#define CFIO_DIAGNOSTIC_GROUNDED_ICE_AREA_CF_NAME "grounded_ice_sheet_area"
#define CFIO_DIAGNOSTIC_FLOATING_ICE_AREA_CF_NAME "floating_ice_sheet_area"
#define CFIO_DIAGNOSTIC_UPPER_SURFACE_FLUX_CF_NAME "tendency_of_land_ice_mass_due_to_surface_mass_balance"
#define CFIO_DIAGNOSTIC_LOWER_SURFACE_FLUX_CF_NAME "tendency_of_land_ice_mass_due_to_basal_mass_balance"
#define CFIO_DIAGNOSTIC_LOWER_SURFACE_FLOATING_ICE_FLUX_CF_NAME "tendency_of_land_ice_mass_due_to_basal_mass_balance"
#define CFIO_DIAGNOSTIC_CALVING_FLUX_CF_NAME "tendency_of_land_ice_mass_due_to_calving"
#define CFIO_DIAGNOSTIC_ICE_FRONT_CALVING_AND_MELTING_CF_NAME "tendency_of_land_ice_mass_due_to_calving_and_ice_front_melting"

#define CFIO_DIAGNOSTIC_ICE_VOLUME_LONG_NAME "Ice mass"
#define CFIO_DIAGNOSTIC_ICE_VAF_LONG_NAME "Ice mass not displaced by seawater"
#define CFIO_DIAGNOSTIC_GROUNDED_ICE_AREA_LONG_NAME "Area covered by grounded ice"
#define CFIO_DIAGNOSTIC_FLOATING_ICE_AREA_LONG_NAME "Area covered by floating ice"
#define CFIO_DIAGNOSTIC_UPPER_SURFACE_FLUX_LONG_NAME "Total SMB flux"
#define CFIO_DIAGNOSTIC_LOWER_SURFACE_FLUX_LONG_NAME "Total BMB flux"
#define CFIO_DIAGNOSTIC_LOWER_SURFACE_FLOATING_ICE_FLUX_LONG_NAME "Total BMB flux beneath floating ice"
#define CFIO_DIAGNOSTIC_CALVING_FLUX_LONG_NAME "Total calving flux"
#define CFIO_DIAGNOSTIC_ICE_FRONT_CALVING_AND_MELTING_LONG_NAME "Total calving and ice front melting flux"

struct cfDiagnostic
{
  std::string short_name;
  std::string long_name;
  std::string cf_name;
  std::string units;
  Vector<Real>* data;
};

class DomainDiagnosticData
{
  Vector<Real> m_time; // time 
  Vector<Real> m_ice_vaf; // total volume above flotation
  Vector<Real> m_ice_volume; // total ice volume
  Vector<Real> m_ice_grounded_area; // grounded ice area
  Vector<Real> m_ice_floating_area; // floating ice area
  Vector<Real> m_ice_total_smb; // total SMB over ice covered regions
  Vector<Real> m_ice_total_bmb; // total BMB over ice covered regions
  Vector<Real> m_ice_floating_total_bmb; // total BMB over floating ice
  Vector<Real> m_ice_total_calving_flux; // total calving flux
  Vector<Real> m_ice_total_calving_and_ice_front_melting_flux; // total calving and ice front melting flux

  Real m_previous_time, m_previous_volume; // used for computing the calving rate
  
  void setCFdata();
  
public:
  DomainDiagnosticData();

private:
  DomainDiagnosticData(const DomainDiagnosticData&);
  DomainDiagnosticData& operator=(const DomainDiagnosticData&);
public:

  Real computeTotalIce
  (const Vector<RefCountedPtr<LevelSigmaCS > >& a_coordSys,
   const Vector<int>& a_refRatio, Real a_crseDx,
   int a_finestLevel) const;

  Real computeVolumeAboveFlotation
  (const Vector<RefCountedPtr<LevelSigmaCS > >& a_coordSys,
   const Vector<int>& a_refRatio, Real a_crseDx,
   int a_finestLevel) const;

  Real computeTotalGroundedIce
  (const Vector<DisjointBoxLayout>& a_grids,
   const Vector<RefCountedPtr<LevelSigmaCS > >& a_coordSys,
    const Vector<int>& a_refRatio, Real a_crseDx,
   int a_finestLevel) const;

  void computeAreaFraction(LevelData<FArrayBox>& a_area,
                           const Vector<RefCountedPtr<LevelSigmaCS > >& a_coordSys,
                           int a_maskVal,
                           int a_level,
                           int a_finestLevel) const;

  Real computeArea
  (int a_maskVal,
   const Vector<RefCountedPtr<LevelSigmaCS > >& a_coordSys,
   const Vector<DisjointBoxLayout>& a_grids,
   const Vector<int>& a_refRatio, Real a_crseDx,
   int a_finestLevel) const;

  Real computeGroundedArea
  (const Vector<RefCountedPtr<LevelSigmaCS > >& a_coordSys,
   const Vector<DisjointBoxLayout>& a_grids,
   const Vector<int>& a_refRatio, Real a_crseDx,
   int a_finestLevel) const;

  Real computeFloatingArea
  (const Vector<RefCountedPtr<LevelSigmaCS > >& a_coordSys,
   const Vector<DisjointBoxLayout>& a_grids,
   const Vector<int>& a_refRatio, Real a_crseDx,
   int a_finestLevel) const;

  Real computeFluxOverIce
  (const Vector<LevelData<FArrayBox>* > a_flux,
   const Vector<RefCountedPtr<LevelSigmaCS > >& a_coordSys,
   const Vector<DisjointBoxLayout>& a_grids,
   const Vector<int>& a_refRatio, Real a_crseDx,
   int a_finestLevel) const;

  Real computeFluxOverMaskedIce
  (int a_maskVal,
   const Vector<LevelData<FArrayBox>* > a_flux,
   const Vector<RefCountedPtr<LevelSigmaCS > >& a_coordSys,
   const Vector<DisjointBoxLayout>& a_grids,
   const Vector<int>& a_refRatio, Real a_crseDx,
   int a_finestLevel) const;

  Real computeDeltaVolumeOverIce
  (const Vector<LevelData<FArrayBox>* >& a_old_thickness,
   const Vector<RefCountedPtr<LevelSigmaCS > >& a_coordSys,
   const Vector<DisjointBoxLayout>& a_grids,
   const Vector<int>& a_refRatio, Real a_crseDx,
   int a_finestLevel) const;

  Real computeTotalFlux
  (const Vector<LevelData<FArrayBox>* > a_flux,
   const Vector<int>& a_refRatio, Real a_crseDx) const;

  void initDiagnostics(AmrIce& a_amrIce,
                       const Vector<RefCountedPtr<LevelSigmaCS > >& a_coordSys,
                       const Vector<DisjointBoxLayout>& a_grids,
                       const Vector<int>& a_refRatio, Real a_crseDx,
                       Real a_time, int a_finestLevel);

  void computeDischarge
  (const Vector<RefCountedPtr<LevelSigmaCS > >& a_coordSys, 
   const Vector<LevelData<FluxBox>* >& a_vectFluxes,
   const Vector<DisjointBoxLayout>& a_grids,
   const Vector<Real>& a_dx,
   const Vector<int>& a_refRatio,
   Real a_time, Real a_offsetTime,
   int a_cur_step, int a_finestLevel, int a_verbosity);

  void endTimestepDiagnostics
  (const Vector<RefCountedPtr<LevelSigmaCS > >& a_coordSys,
   const Vector<LevelData<FArrayBox>* > a_old_thickness,
   const Vector<LevelData<FArrayBox>* > a_divThicknessFlux, 
   const Vector<LevelData<FArrayBox>* > a_basalThicknessSource,
   const Vector<LevelData<FArrayBox>* > a_surfaceThicknessSource,
   const Vector<LevelData<FArrayBox>* > a_volumeThicknessSource,
   const Vector<LevelData<FArrayBox>* > a_calvedIceThickness,
   const Vector<LevelData<FArrayBox>* > a_addedIceThickness,
   const Vector<LevelData<FArrayBox>* > a_removedIceThickness,
   const Vector<DisjointBoxLayout>& a_grids,
   const Vector<int>& a_refRatio, Real a_crseDx,
   Real a_time, Real a_offsetTime, Real a_dt,
   int a_cur_step, int a_finestLevel, int a_verbosity);

  void record(AmrIce& a_amrIce);
  void reset();
  
#ifdef CH_USE_HDF5
  void write(HDF5Handle& a_handle);
  void read(HDF5Handle& a_handle);
#endif


  Real m_diagnostic_values[10]={0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0}; 
  //cfDiagnostic m_cf_stuff[10]; 
  vector<cfDiagnostic> m_cf_stuff; 

  bool m_report_grounded_ice;

  bool m_report_area;

  bool m_report_total_flux;

  bool m_report_calving;

  Real m_initialSumIce;

  Real m_lastSumIce;

  Real m_lastSumCalvedIce;

  Real m_initialSumGroundedIce;

  Real m_lastSumGroundedIce;

  Real m_initialVolumeAboveFlotation;
 
  Real m_lastVolumeAboveFlotation;

};

  
#include "NamespaceFooter.H"

#endif