Misfit Class Reference

#include <Misfit.h>

Inheritance diagram for Misfit:

Public Member Functions
	Misfit ()
	Misfit (char *in_name, int in_definitionenum, int in_model_enum, int in_observation_enum, char *in_timeinterpolation, int in_local, int in_weights_enum)
	~Misfit ()
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
int	local
int	model_enum
char *	name
int	observation_enum
char *	timeinterpolation
int	weights_enum
int	lock
IssmDouble	misfit

Detailed Description

Definition at line 15 of file Misfit.h.

Constructor & Destructor Documentation

Misfit() [1/2]

Misfit::Misfit

(

)

Definition at line 26 of file Misfit.cpp.

              {/*{{{*/
 
   this->definitionenum = -1;
   this->name = NULL;
   this->model_enum = UNDEF;
   this->observation_enum = UNDEF;
   this->weights_enum = UNDEF;
   this->timeinterpolation=NULL;
   this->local=1;
   this->misfit=0;
   this->lock=0;
 
}

Misfit() [2/2]

Misfit::Misfit	(	char *	in_name,
		int	in_definitionenum,
		int	in_model_enum,
		int	in_observation_enum,
		char *	in_timeinterpolation,
		int	in_local,
		int	in_weights_enum
	)

Definition at line 40 of file Misfit.cpp.

                                                                                                                                                             {/*{{{*/
 
   this->definitionenum=in_definitionenum;
 
   this->name     = xNew<char>(strlen(in_name)+1);
   xMemCpy<char>(this->name,in_name,strlen(in_name)+1);
 
   this->timeinterpolation = xNew<char>(strlen(in_timeinterpolation)+1);
   xMemCpy<char>(this->timeinterpolation,in_timeinterpolation,strlen(in_timeinterpolation)+1);
 
   this->model_enum=in_model_enum;
   this->observation_enum=in_observation_enum;
   this->weights_enum=in_weights_enum;
   this->local=in_local;
 
   this->misfit=0;
   this->lock=0;
}

~Misfit()

Misfit::~Misfit

(

)

Definition at line 59 of file Misfit.cpp.

               {/*{{{*/
   if(this->name)xDelete(this->name);
   if(this->timeinterpolation)xDelete(this->timeinterpolation);
   this->misfit=0;
   this->lock=0;
}

Member Function Documentation

copy()

Object * Misfit::copy ( void  )

virtual

Implements Object.

Definition at line 67 of file Misfit.cpp.

                     {/*{{{*/
   Misfit* mf = new Misfit(this->name,this->definitionenum, this->model_enum,this->observation_enum,this->timeinterpolation,this->local,this->weights_enum);
   mf->misfit=this->misfit;
   mf->lock=this->lock;
   return (Object*) mf;
}

DeepEcho()

void Misfit::DeepEcho ( void  )

virtual

Implements Object.

Definition at line 74 of file Misfit.cpp.

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

Echo()

void Misfit::Echo ( void  )

virtual

Implements Object.

Definition at line 78 of file Misfit.cpp.

                     {/*{{{*/
   _printf_(" Misfit: " << name << " " << this->definitionenum << "\n");
   _printf_("    model_enum: " << model_enum << " " << EnumToStringx(model_enum) << "\n");
   _printf_("    observation_enum: " << observation_enum << " " << EnumToStringx(observation_enum) << "\n");
   _printf_("    weights_enum: " << weights_enum << " " << EnumToStringx(weights_enum) << "\n");
   _printf_("    timeinterpolation: " << timeinterpolation << "\n");
   _printf_("    local: " << local << "\n");
}

Id()

int Misfit::Id ( void  )

virtual

Implements Object.

Definition at line 87 of file Misfit.cpp.

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

Marshall()

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

virtual

Implements Object.

Definition at line 91 of file Misfit.cpp.

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

ObjectEnum()

int Misfit::ObjectEnum ( void  )

virtual

Implements Object.

Definition at line 95 of file Misfit.cpp.

                          {/*{{{*/
   return MisfitEnum;
}

DefinitionEnum()

int Misfit::DefinitionEnum ( )

virtual

Implements Definition.

Definition at line 100 of file Misfit.cpp.

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

Name()

char * Misfit::Name ( )

virtual

Implements Definition.

Definition at line 104 of file Misfit.cpp.

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

Response()

IssmDouble Misfit::Response ( FemModel *  femmodel )

virtual

Implements Definition.

Definition at line 111 of file Misfit.cpp.

                                             {/*{{{*/
 
    /*diverse: */
    IssmDouble time,starttime,finaltime;
    IssmDouble dt;
 
    /*recover time parameters: */
    femmodel->parameters->FindParam(&starttime,TimesteppingStartTimeEnum);
    femmodel->parameters->FindParam(&finaltime,TimesteppingFinalTimeEnum);
    femmodel->parameters->FindParam(&time,TimeEnum);
    femmodel->parameters->FindParam(&dt,TimesteppingTimeStepEnum);
 
    if (this->local==1){ /*area integration using elements: {{{*/
 
       int i;
       IssmDouble misfit_t=0.;
       IssmDouble all_misfit_t=0.;
       IssmDouble area_t=0.;
       IssmDouble all_area_t;
 
       /*If we are locked, return time average: */
       if(this->lock)return misfit/(time-starttime);
 
       for(i=0;i<femmodel->elements->Size();i++){
          Element* element=(Element*)femmodel->elements->GetObjectByOffset(i);
          misfit_t+=element->Misfit(model_enum,observation_enum,weights_enum);
          area_t+=element->MisfitArea(weights_enum);
       }
 
       ISSM_MPI_Allreduce ( (void*)&misfit_t,(void*)&all_misfit_t,1,ISSM_MPI_DOUBLE,ISSM_MPI_SUM,IssmComm::GetComm());
       ISSM_MPI_Allreduce ( (void*)&area_t,(void*)&all_area_t,1,ISSM_MPI_DOUBLE,ISSM_MPI_SUM,IssmComm::GetComm());
       area_t=all_area_t;
       misfit_t=all_misfit_t;
 
       /*Divide by surface area if not nill!: */
       if (area_t!=0) misfit_t=misfit_t/area_t;
 
       /*Add this time's contribution to curent misfit: */
       misfit+=dt*misfit_t;
 
       /*Do we lock? i.e. are we at final_time? :*/
       if(time==finaltime)this->lock=1;
 
       /*What we return is the value of misfit / time if transient*/
       if(time!=0.) return misfit/(time-starttime); 
       return misfit;
    } /*}}}*/
    else if (this->local==2){ /*vertex by vertex computation: {{{*/
 
       IssmDouble* model = NULL;
       IssmDouble* observation= NULL;
       IssmDouble* weights= NULL;
       int msize,osize,wsize;
 
       /*Are we transient?:*/
       if (time==0){
          IssmDouble misfit_t=0.;
 
          /*get global vectors: */
          GetVectorFromInputsx(&model,&msize,femmodel,model_enum);
          GetVectorFromInputsx(&observation,&osize,femmodel,observation_enum);_assert_(msize==osize);
          GetVectorFromInputsx(&weights,&wsize,femmodel,weights_enum); _assert_(wsize==msize);
 
          int count=0;
          for (int i=0;i<msize;i++){
             misfit_t += pow(model[i]-observation[i],2)*weights[i];
             if (weights[i]!=0)count++;
          }
          misfit=sqrt(misfit_t/count);
 
          /*Free ressources:*/
          xDelete<IssmDouble>(model);
          xDelete<IssmDouble>(observation);
          xDelete<IssmDouble>(weights);
 
          /*return value: */
          return misfit;
       }
       else{
 
          IssmDouble misfit_t=0.;
          IssmDouble all_misfit_t=0.;
 
          /*If we are locked, return time average: */
          if(this->lock)return misfit/(time-starttime);
 
          /*get global vectors: */
          GetVectorFromInputsx(&model,&msize,femmodel,model_enum);
          GetVectorFromInputsx(&observation,&osize,femmodel,observation_enum);_assert_(msize==osize);
          GetVectorFromInputsx(&weights,&wsize,femmodel,weights_enum); _assert_(wsize==msize);
 
          int count=0;
          for (int i=0;i<msize;i++){
             misfit_t += pow(model[i]-observation[i],2)*weights[i];
             if (weights[i]!=0)count++;
          }
          misfit=sqrt(misfit_t/count);
 
          /*Add this time's contribution to curent misfit: */
          misfit=sqrt(misfit_t)/count;
          misfit+=dt*misfit_t;
 
          /*Do we lock? i.e. are we at final_time? :*/
          if(time==finaltime)this->lock=1;
 
          /*Free ressources:*/
          xDelete<IssmDouble>(model);
          xDelete<IssmDouble>(observation);
          xDelete<IssmDouble>(weights);
 
          /*What we return is the value of misfit / time: */
          return misfit/(time-starttime);
       }
 
    } /*}}}*/
    else{ /*global computation: {{{ */
 
       IssmDouble model, observation;
 
       /*If we are locked, return time average: */
       if(this->lock)return misfit/(time-starttime);
 
       /*First, the global  model response: */
       model=OutputDefinitionsResponsex(femmodel,this->model_enum);
       /*Now, the observation is buried inside the elements, go fish it in the first element (cludgy, needs fixing): */
       Element* element = (Element*)femmodel->elements->GetObjectByOffset(0); _assert_(element);
       Input2*  input   = element->GetInput2(observation_enum); _assert_(input);
       input->GetInputAverage(&observation);
 
       /*Add this time's contribution to curent misfit: */
       misfit+=dt*(model-observation);
 
       /*Do we lock? i.e. are we at final_time? :*/
       if(time==finaltime)this->lock=1;
 
       /*What we return is the value of misfit / time: */
       return misfit/(time-starttime);
    } /*}}}*/
 
 }

Field Documentation

definitionenum

int Misfit::definitionenum

Definition at line 19 of file Misfit.h.

local

int Misfit::local

Definition at line 20 of file Misfit.h.

model_enum

int Misfit::model_enum

Definition at line 21 of file Misfit.h.

name

char* Misfit::name

Definition at line 22 of file Misfit.h.

observation_enum

int Misfit::observation_enum

Definition at line 23 of file Misfit.h.

timeinterpolation

char* Misfit::timeinterpolation

Definition at line 24 of file Misfit.h.

weights_enum

int Misfit::weights_enum

Definition at line 25 of file Misfit.h.

lock

int Misfit::lock

Definition at line 27 of file Misfit.h.

misfit

IssmDouble Misfit::misfit

Definition at line 28 of file Misfit.h.

---

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

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