v0.13.0
Public Member Functions | Static Public Member Functions | List of all members
MethodForForceScaling Struct Referenceabstract

Class used to scale loads, f.e. in arc-length control. More...

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

Inheritance diagram for MethodForForceScaling:
[legend]

Public Member Functions

virtual MoFEMErrorCode scaleNf (const FEMethod *fe, VectorDouble &Nf)=0
 
virtual MoFEMErrorCode getForceScale (const double ts_t, double &scale)
 
virtual ~MethodForForceScaling ()
 

Static Public Member Functions

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

Class used to scale loads, f.e. in arc-length control.

Examples
NavierStokesElement.hpp.

Definition at line 23 of file MethodForForceScaling.hpp.

Constructor & Destructor Documentation

◆ ~MethodForForceScaling()

virtual MethodForForceScaling::~MethodForForceScaling ( )
virtual

Definition at line 51 of file MethodForForceScaling.hpp.

51 {}

Member Function Documentation

◆ applyScale() [1/2]

static MoFEMErrorCode MethodForForceScaling::applyScale ( const FEMethod fe,
boost::ptr_vector< MethodForForceScaling > &  methods_op,
VectorDouble &  nf 
)
static

Definition at line 33 of file MethodForForceScaling.hpp.

35  {
37  for (auto vit = methods_op.begin(); vit != methods_op.end(); vit++)
38  CHKERR vit->scaleNf(fe, nf);
40  }
#define MoFEMFunctionBegin
First executable line of each MoFEM function, used for error handling. Final line of MoFEM functions ...
Definition: definitions.h:359
#define MoFEMFunctionReturn(a)
Last executable line of each PETSc function used for error handling. Replaces return()
Definition: definitions.h:429
#define CHKERR
Inline error check.
Definition: definitions.h:548

◆ applyScale() [2/2]

static MoFEMErrorCode MethodForForceScaling::applyScale ( const FEMethod fe,
boost::shared_ptr< MethodForForceScaling method_op,
VectorDouble &  nf 
)
static

Definition at line 43 of file MethodForForceScaling.hpp.

45  {
47  CHKERR method_op->scaleNf(fe, nf);
49  }

◆ getForceScale()

virtual MoFEMErrorCode MethodForForceScaling::getForceScale ( const double  ts_t,
double &  scale 
)
virtual

Reimplemented in TimeForceScale.

Definition at line 26 of file MethodForForceScaling.hpp.

26  {
28  SETERRQ(PETSC_COMM_SELF, MOFEM_NOT_IMPLEMENTED, "not implemented");
30  }
#define MoFEMFunctionReturnHot(a)
Last executable line of each PETSc function used for error handling. Replaces return()
Definition: definitions.h:460
@ MOFEM_NOT_IMPLEMENTED
Definition: definitions.h:45
#define MoFEMFunctionBeginHot
First executable line of each MoFEM function, used for error handling. Final line of MoFEM functions ...
Definition: definitions.h:453

◆ scaleNf()

virtual MoFEMErrorCode MethodForForceScaling::scaleNf ( const FEMethod fe,
VectorDouble &  Nf 
)
pure virtual

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