GPLIB++
Public Member Functions | List of all members
gplib::CombinedRoughness Class Reference

CombinedRoughness calculates the roughness of a joint MT- receiver functions model without consideration for different parameter ranges. More...

#include <CombinedRoughness.h>

Inheritance diagram for gplib::CombinedRoughness:
Inheritance graph
[legend]

Public Member Functions

virtual CombinedRoughnessclone () const
 Clone the object. More...
 
void SetRefCond (const double cond)
 Set reference conductivity for roughness calculation, changes weighting between velocity and conductivity. More...
 
void SetRefVel (const double vel)
 Set reference velcoity for roughness calculation, changes weighting between velocity and conductivity. More...
 
virtual void SafeParallel (const ttranscribed &member)
 Calculate the roughness of the model given by the parameter member. More...
 
virtual double PostParallel (const ttranscribed &member)
 Some operations cannot be done in parallel, these are done after, returns the misfit value. More...
 
 CombinedRoughness (const CombinedRoughness &Old)
 We have to copy the base class and the local data. More...
 
CombinedRoughnessoperator= (const CombinedRoughness &source)
 We have to copy the base class and the local data. More...
 
 CombinedRoughness ()
 
virtual ~CombinedRoughness ()
 
- Public Member Functions inherited from gplib::GeneralObjective
void SetFitExponent (const int x)
 Set the Fit exponent. More...
 
int GetFitExponent ()
 Get the Fit exponent. More...
 
double GetRMS ()
 Get the current RMS. More...
 
const std::string & GetParallelID ()
 Derived classes need to read the ParallelId for their forward calculations. More...
 
void SetParallelID (const std::string &s)
 We need to set the parallel ID outside the Objective function object. More...
 
const tmisfitGetMisfit ()
 Return the misfit vector. More...
 
const tdataGetSynthData ()
 Return the current synthetic data. More...
 
virtual void PreParallel (const ttranscribed &member)
 Some operations cannot be done in parallel, these are done before. More...
 
double CalcPerformance (const ttranscribed &member)
 For serial execution CalcPerformance calls the three Parallel functions for more convenient use. More...
 
 GeneralObjective ()
 
 GeneralObjective (const GeneralObjective &Old)
 
GeneralObjectiveoperator= (const GeneralObjective &source)
 
virtual ~GeneralObjective ()
 

Additional Inherited Members

- Protected Member Functions inherited from gplib::GeneralObjective
double CalcMisfit (const double measured, const double predicted, const double measerror, const double errorlevel, const int index)
 
void SetRMS (const double x)
 
tmisfitSetMisfit ()
 Only derived classes can write access the Misfit. More...
 
void SetMisfit (const tmisfit &LocalMisfit)
 
tdataSetSynthData ()
 Only derived classes can write access the Synthetic data. More...
 
void SetSynthData (const tdata &LocalSynthData)
 

Detailed Description

CombinedRoughness calculates the roughness of a joint MT- receiver functions model without consideration for different parameter ranges.

Definition at line 8 of file CombinedRoughness.h.

Constructor & Destructor Documentation

gplib::CombinedRoughness::CombinedRoughness ( const CombinedRoughness Old)

We have to copy the base class and the local data.

Definition at line 40 of file CombinedRoughness.cpp.

gplib::CombinedRoughness::CombinedRoughness ( )

Definition at line 8 of file CombinedRoughness.cpp.

Referenced by clone().

gplib::CombinedRoughness::~CombinedRoughness ( )
virtual

Definition at line 13 of file CombinedRoughness.cpp.

Member Function Documentation

virtual CombinedRoughness* gplib::CombinedRoughness::clone ( ) const
inlinevirtual

Clone the object.

Implements gplib::GeneralObjective.

Definition at line 15 of file CombinedRoughness.h.

References CombinedRoughness().

CombinedRoughness & gplib::CombinedRoughness::operator= ( const CombinedRoughness source)

We have to copy the base class and the local data.

Definition at line 46 of file CombinedRoughness.cpp.

References gplib::GeneralObjective::operator=().

double gplib::CombinedRoughness::PostParallel ( const ttranscribed member)
virtual

Some operations cannot be done in parallel, these are done after, returns the misfit value.

Implements gplib::GeneralObjective.

Definition at line 34 of file CombinedRoughness.cpp.

References gplib::GeneralObjective::GetRMS().

void gplib::CombinedRoughness::SafeParallel ( const ttranscribed member)
virtual

Calculate the roughness of the model given by the parameter member.

Reimplemented from gplib::GeneralObjective.

Definition at line 18 of file CombinedRoughness.cpp.

References gplib::GeneralObjective::GetFitExponent(), and gplib::GeneralObjective::SetRMS().

void gplib::CombinedRoughness::SetRefCond ( const double  cond)
inline

Set reference conductivity for roughness calculation, changes weighting between velocity and conductivity.

Definition at line 20 of file CombinedRoughness.h.

void gplib::CombinedRoughness::SetRefVel ( const double  vel)
inline

Set reference velcoity for roughness calculation, changes weighting between velocity and conductivity.

Definition at line 25 of file CombinedRoughness.h.


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