TimeForceScale Struct Reference

Force scale operator for reading two columns. More...

#include <users_modules/basic_finite_elements/src/TimeForceScale.hpp>

Inheritance diagram for TimeForceScale:

Collaboration diagram for TimeForceScale:

Public Member Functions
	TimeForceScale (string name="-my_time_data_file", bool error_if_file_not_given=false)
MoFEMErrorCode	timeData ()
MoFEMErrorCode	getForceScale (const double ts_t, double &scale)
MoFEMErrorCode	scaleNf (const FEMethod *fe, VectorDouble &Nf)
	Scale force the right hand vector. More...
Public Member Functions inherited from MethodForForceScaling
virtual	~MethodForForceScaling ()

Public Attributes
std::map< double, double >	tSeries
int	readFile
int	debug
string	nAme
bool	errorIfFileNotGiven
PetscBool	fLg

Additional Inherited Members
Static Public Member Functions inherited from MethodForForceScaling
static MoFEMErrorCode	applyScale (const FEMethod *fe, boost::ptr_vector< MethodForForceScaling > &methods_op, VectorDouble &nf)
static MoFEMErrorCode	applyScale (const FEMethod *fe, boost::shared_ptr< MethodForForceScaling > method_op, VectorDouble &nf)

Detailed Description

Force scale operator for reading two columns.

Examples

bone_adaptation.cpp, nonlinear_dynamics.cpp, Remodeling.cpp, and UnsaturatedFlow.hpp.

Definition at line 18 of file TimeForceScale.hpp.

Constructor & Destructor Documentation

TimeForceScale()

TimeForceScale::TimeForceScale ( string  name = "-my_time_data_file", bool  error_if_file_not_given = false  )

inline

Definition at line 25 of file TimeForceScale.hpp.

      : readFile(0), debug(0), nAme(name),
        errorIfFileNotGiven(error_if_file_not_given) {
 
    ierr = timeData();
    CHKERRABORT(PETSC_COMM_WORLD, ierr);
  }

Member Function Documentation

getForceScale()

MoFEMErrorCode TimeForceScale::getForceScale ( const double  ts_t, double &  scale  )

inlinevirtual

Reimplemented from MethodForForceScaling.

Definition at line 89 of file TimeForceScale.hpp.

                                                                 {
    MoFEMFunctionBeginHot;
    if (!fLg) {
      scale = ts_t; // scale with time, by default
      MoFEMFunctionReturnHot(0);
    }
    if (readFile == 0) {
      SETERRQ(PETSC_COMM_SELF, 1, "data file not read");
    }
    scale = 0;
    double t0 = 0, t1, s0 = tSeries[0], s1, dt;
    std::map<double, double>::iterator tit = tSeries.begin();
    for (; tit != tSeries.end(); tit++) {
      if (tit->first > ts_t) {
        t1 = tit->first;
        s1 = tit->second;
        dt = ts_t - t0;
        scale = s0 + ((s1 - s0) / (t1 - t0)) * dt;
        break;
      }
      t0 = tit->first;
      s0 = tit->second;
      scale = s0;
    }
    MoFEMFunctionReturnHot(0);
  }

scaleNf()

MoFEMErrorCode TimeForceScale::scaleNf ( const FEMethod *  fe, VectorDouble &  Nf  )

inlinevirtual

Scale force the right hand vector.

Parameters

fe
Nf

Returns

MoFEMErrorCode

Implements MethodForForceScaling.

Definition at line 123 of file TimeForceScale.hpp.

                                                               {
    MoFEMFunctionBegin;
    double scale;
    const double ts_t = fe->ts_t;
    CHKERR getForceScale(ts_t, scale);
    Nf *= scale;
    MoFEMFunctionReturn(0);
  }

timeData()

MoFEMErrorCode TimeForceScale::timeData ( )

inline

Definition at line 36 of file TimeForceScale.hpp.

                            {
    MoFEMFunctionBeginHot;
    char time_file_name[255];
    ierr = PetscOptionsGetString(PETSC_NULL, PETSC_NULL, nAme.c_str(),
                                 time_file_name, 255, &fLg);
    CHKERRG(ierr);
    if (!fLg && errorIfFileNotGiven) {
      SETERRQ1(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY,
               "*** ERROR %s (time_data FILE NEEDED)", nAme.c_str());
    }
    if (!fLg) {
      MOFEM_LOG_C("WORLD", Sev::warning,
                  "The %s file not provided. Loading scaled with time.",
                  nAme.c_str());
      MoFEMFunctionReturnHot(0);
    }
    FILE *time_data = fopen(time_file_name, "r");
    if (time_data == NULL) {
      SETERRQ1(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY,
               "*** ERROR data file < %s > open unsuccessful", time_file_name);
    }
    double no1 = 0.0, no2 = 0.0;
    tSeries[no1] = no2;
    while (!feof(time_data)) {
      int n = fscanf(time_data, "%lf %lf", &no1, &no2);
      if ((n <= 0) || ((no1 == 0) && (no2 == 0))) {
        fgetc(time_data);
        continue;
      }
      if (n != 2) {
        SETERRQ1(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY,
                 "*** ERROR read data file error (check input time data file) "
                 "{ n = %d }",
                 n);
      }
      tSeries[no1] = no2;
    }
    int r = fclose(time_data);
    if (debug) {
      std::map<double, double>::iterator tit = tSeries.begin();
      for (; tit != tSeries.end(); tit++) {
        PetscPrintf(PETSC_COMM_WORLD, "** read time series %3.2e time %3.2e\n",
                    tit->first, tit->second);
      }
    }
    if (r != 0) {
      SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY,
              "*** ERROR file close unsuccessful");
    }
    readFile = 1;
    MoFEMFunctionReturnHot(0);
  }

Member Data Documentation

debug

int TimeForceScale::debug

Definition at line 21 of file TimeForceScale.hpp.

errorIfFileNotGiven

bool TimeForceScale::errorIfFileNotGiven

Definition at line 23 of file TimeForceScale.hpp.

fLg

PetscBool TimeForceScale::fLg

Definition at line 34 of file TimeForceScale.hpp.

nAme

string TimeForceScale::nAme

Definition at line 22 of file TimeForceScale.hpp.

readFile

int TimeForceScale::readFile

Definition at line 21 of file TimeForceScale.hpp.

tSeries

std::map<double, double> TimeForceScale::tSeries

Definition at line 20 of file TimeForceScale.hpp.

---

The documentation for this struct was generated from the following file:

• users_modules/basic_finite_elements/src/TimeForceScale.hpp