Regionaloutput Class Reference

#include <Regionaloutput.h>

Inheritance diagram for Regionaloutput:

Public Member Functions
	Regionaloutput ()
	Regionaloutput (char *in_name, int in_definitionenum, char *in_outputname, IssmDouble *maskin, int Min)
	~Regionaloutput ()
Object *	copy ()
void	DeepEcho (void)
void	Echo (void)
int	Id (void)
void	Marshall (char **pmarshalled_data, int *pmarshalled_data_size, int marshall_direction)
int	ObjectEnum (void)
int	DefinitionEnum ()
char *	Name ()
IssmDouble	Response (FemModel *femmodel)
Public Member Functions inherited from Object
virtual	~Object ()
Public Member Functions inherited from Definition
virtual	~Definition ()

Data Fields
int	definitionenum
char *	outputname
char *	name
IssmDouble *	mask
int	M

Detailed Description

Definition at line 15 of file Regionaloutput.h.

Constructor & Destructor Documentation

Regionaloutput() [1/2]

Regionaloutput::Regionaloutput

(

)

Regionaloutput() [2/2]

Regionaloutput::Regionaloutput	(	char *	in_name,
		int	in_definitionenum,
		char *	in_outputname,
		IssmDouble *	maskin,
		int	Min
	)

Definition at line 22 of file Regionaloutput.cpp.

                                                                                                                    { /*{{{*/
 
   this->definitionenum=in_definitionenum;
   this->outputname = xNew<char>(strlen(in_outputname)+1);
   xMemCpy<char>(this->outputname,in_outputname,strlen(in_outputname)+1);
   this->name = xNew<char>(strlen(in_name)+1);
   xMemCpy<char>(this->name,in_name,strlen(in_name)+1);
 
   this->mask   = xNew<IssmDouble>(Min);
   xMemCpy<IssmDouble>(this->mask, maskin, Min);
 
   this->M=Min;
 
}

~Regionaloutput()

Regionaloutput::~Regionaloutput

(

)

Definition at line 37 of file Regionaloutput.cpp.

                               {/*{{{*/
   if(this->name)xDelete(this->name); 
   if(this->outputname)xDelete(this->outputname);
   if(this->mask)xDelete(this->mask);
}

Member Function Documentation

copy()

Object * Regionaloutput::copy ( void  )

virtual

Implements Object.

Definition at line 45 of file Regionaloutput.cpp.

                             {/*{{{*/
   Regionaloutput* mf = new Regionaloutput(this->name,this->definitionenum,this->outputname,this->mask,this->M);
   return (Object*) mf;
}

DeepEcho()

void Regionaloutput::DeepEcho ( void  )

virtual

Implements Object.

Definition at line 50 of file Regionaloutput.cpp.

                                 {/*{{{*/
   this->Echo();
}

Echo()

void Regionaloutput::Echo ( void  )

virtual

Implements Object.

Definition at line 54 of file Regionaloutput.cpp.

                             {/*{{{*/
   _printf_(" Regionaloutput: " << this->name << " " << this->definitionenum << "\n");
   _printf_("    outputname enum: " << this->outputname << "Enum\n");
   _printf_("    mask: " << this->mask << "\n");
   _printf_("    M: " << this->M << "\n");
}

Id()

int Regionaloutput::Id ( void  )

virtual

Implements Object.

Definition at line 61 of file Regionaloutput.cpp.

                          {/*{{{*/
   return -1;
}

Marshall()

void Regionaloutput::Marshall ( char **  pmarshalled_data, int *  pmarshalled_data_size, int  marshall_direction  )

virtual

Implements Object.

Definition at line 65 of file Regionaloutput.cpp.

                                                                                                       {/*{{{*/
   _error_("not implemented yet!"); 
} 

ObjectEnum()

int Regionaloutput::ObjectEnum ( void  )

virtual

Implements Object.

Definition at line 69 of file Regionaloutput.cpp.

                                  {/*{{{*/
   return RegionaloutputEnum;
}

DefinitionEnum()

int Regionaloutput::DefinitionEnum ( )

virtual

Implements Definition.

Definition at line 75 of file Regionaloutput.cpp.

                                  {/*{{{*/
 
   return this->definitionenum;
}

Name()

char * Regionaloutput::Name ( )

virtual

Implements Definition.

Definition at line 80 of file Regionaloutput.cpp.

                          {/*{{{*/
 
   char* name2=xNew<char>(strlen(this->name)+1);
   xMemCpy(name2,this->name,strlen(this->name)+1);
 
   return name2;
}

Response()

IssmDouble Regionaloutput::Response ( FemModel *  femmodel )

virtual

Implements Definition.

Definition at line 88 of file Regionaloutput.cpp.

                                                     {/*{{{*/
 
   int i;
   IssmDouble val_t=0.;
   IssmDouble all_val_t=0.;
   int outputenum = StringToEnumx(this->outputname);
 
   for(i=0;i<femmodel->elements->Size();i++){
      Element* element=(Element*)femmodel->elements->GetObjectByOffset(i);
      switch(outputenum){
         case GroundedAreaEnum:
            val_t+=element->GroundedArea(this->mask,false);
            break;
         case GroundedAreaScaledEnum:
            val_t+=element->GroundedArea(this->mask,true);
            break;
         case FloatingAreaEnum:
            val_t+=element->FloatingArea(this->mask,false);
            break;
         case FloatingAreaScaledEnum:
            val_t+=element->FloatingArea(this->mask,true);
            break;
         case IceMassEnum:
            val_t+=element->IceMass(this->mask,false);
            break;
         case IceMassScaledEnum:
            val_t+=element->IceMass(this->mask,true);
            break;
         case IceVolumeEnum:
            val_t+=element->IceVolume(this->mask,false);
            break;
         case IceVolumeScaledEnum:
            val_t+=element->IceVolume(this->mask,true);
            break;
         case IceVolumeAboveFloatationEnum:
            val_t+=element->IceVolumeAboveFloatation(this->mask,false);
            break;
         case IceVolumeAboveFloatationScaledEnum:
            val_t+=element->IceVolumeAboveFloatation(this->mask,true);
            break;
         case TotalFloatingBmbEnum:
            val_t+=element->TotalFloatingBmb(this->mask,false);
            break;
         case TotalFloatingBmbScaledEnum:
            val_t+=element->TotalFloatingBmb(this->mask,true);
            break;
         case TotalGroundedBmbEnum:
            val_t+=element->TotalGroundedBmb(this->mask,false);
            break;
         case TotalGroundedBmbScaledEnum:
            val_t+=element->TotalGroundedBmb(this->mask,true);
            break;
         case TotalSmbEnum:
            val_t+=element->TotalSmb(this->mask,false);
            break;
         case TotalSmbScaledEnum:
            val_t+=element->TotalSmb(this->mask,true);
            break;
         default:
            _error_("Regional output type " << this->outputname << " not supported yet!");
      }
   }
 
   ISSM_MPI_Allreduce ( (void*)&val_t,(void*)&all_val_t,1,ISSM_MPI_DOUBLE,ISSM_MPI_SUM,IssmComm::GetComm());
   val_t=all_val_t;
 
   return val_t;
}

Field Documentation

definitionenum

int Regionaloutput::definitionenum

Definition at line 19 of file Regionaloutput.h.

outputname

char* Regionaloutput::outputname

Definition at line 20 of file Regionaloutput.h.

name

char* Regionaloutput::name

Definition at line 21 of file Regionaloutput.h.

mask

IssmDouble* Regionaloutput::mask

Definition at line 22 of file Regionaloutput.h.

M

int Regionaloutput::M

Definition at line 23 of file Regionaloutput.h.

---

The documentation for this class was generated from the following files:

• src/c/classes/Regionaloutput.h
• src/c/classes/Regionaloutput.cpp