MixTransport::MaterialWithAutomaticDifferentiation Struct Reference

#include <users_modules/tutorials/cor-0to1/src/MaterialUnsaturatedFlow.hpp>

Inheritance diagram for MixTransport::MaterialWithAutomaticDifferentiation:

Collaboration diagram for MixTransport::MaterialWithAutomaticDifferentiation:

Public Member Functions
	MaterialWithAutomaticDifferentiation (const CommonMaterialData &data)
template<typename TYPE >
TYPE	funSe (TYPE &theta)
virtual void	recordTheta ()=0
virtual void	recordKr ()=0
MoFEMErrorCode	calK ()
MoFEMErrorCode	calDiffK ()
MoFEMErrorCode	calC ()
MoFEMErrorCode	calDiffC ()
MoFEMErrorCode	calTheta ()
MoFEMErrorCode	calSe ()
Public Member Functions inherited from MixTransport::CommonMaterialData
	CommonMaterialData ()
double	initialPcEval () const
	Initialize head. More...
void	addOptions (po::options_description &o, const std::string &prefix)
void	printMatParameters (const int id, const std::string &prefix) const
Public Member Functions inherited from MixTransport::GenericMaterial
virtual	~GenericMaterial ()

Public Attributes
double	Kr
double	diffKr
Public Attributes inherited from MixTransport::CommonMaterialData
int	blockId
	Block Id. More...
std::string	matName
	material name More...
double	Ks
	Saturated hydraulic conductivity [m/day]. More...
double	hS
	minimum capillary height [m] More...
double	thetaS
	saturated water content More...
double	thetaR
	residual water contents More...
double	thetaM
	model parameter More...
double	alpha
	model parameter More...
double	n
	model parameter More...
double	Ah
	Initial hydraulic head coefficient. More...
double	AhZ
	Initial hydraulic head coefficient. More...
double	AhZZ
	Initial hydraulic head coefficient. More...
Public Attributes inherited from MixTransport::GenericMaterial
double	sCale
	Scale time dependent eq. More...
double	h
	hydraulic head More...
double	h_t
	rate of hydraulic head More...
double	K
	Hydraulic conductivity [L/s]. More...
double	diffK
	Derivative of hydraulic conductivity [L/s * L^2/F]. More...
double	C
	Capacity [S^2/L^2]. More...
double	diffC
	Derivative of capacity [S^2/L^2 * L^2/F ]. More...
double	tHeta
	Water content. More...
double	Se
	Effective saturation. More...
Range	tEts
	Elements with this material. More...
double	x
double	y
double	z
	in meters (L) More...

Additional Inherited Members
Public Types inherited from MixTransport::CommonMaterialData
typedef boost::function< boost::shared_ptr< CommonMaterialData > const CommonMaterialData &data)>	RegisterHook
Static Public Attributes inherited from MixTransport::GenericMaterial
static double	ePsilon0 = 0
	Regularization parameter. More...
static double	ePsilon1 = 0
	Regularization parameter. More...
static double	scaleZ = 1
	Scale z direction. More...

Detailed Description

Definition at line 148 of file MaterialUnsaturatedFlow.hpp.

Constructor & Destructor Documentation

MaterialWithAutomaticDifferentiation()

MixTransport::MaterialWithAutomaticDifferentiation::MaterialWithAutomaticDifferentiation ( const CommonMaterialData &  data )

inline

Definition at line 149 of file MaterialUnsaturatedFlow.hpp.

      : CommonMaterialData(data) {}

Member Function Documentation

calC()

MoFEMErrorCode MixTransport::MaterialWithAutomaticDifferentiation::calC ( )

inlinevirtual

Reimplemented from MixTransport::GenericMaterial.

Definition at line 194 of file MaterialUnsaturatedFlow.hpp.

                        {
    MoFEMFunctionBeginHot;
    if (h < hS) {
      int r = ::gradient(2 * blockId + 0, 1, &h, &C);
      if (r < 0) {
        SETERRQ(PETSC_COMM_SELF, MOFEM_OPERATION_UNSUCCESSFUL,
                "ADOL-C function evaluation with error");
      }
    } else {
      C = 0;
    }
    C += ePsilon1;
    MoFEMFunctionReturnHot(0);
  }

calDiffC()

MoFEMErrorCode MixTransport::MaterialWithAutomaticDifferentiation::calDiffC ( )

inlinevirtual

Reimplemented from MixTransport::GenericMaterial.

Definition at line 209 of file MaterialUnsaturatedFlow.hpp.

                            {
    MoFEMFunctionBeginHot;
    if (h < hS) {
      double v = 1;
      int r = ::hess_vec(2 * blockId + 0, 1, &h, &v, &diffC);
      if (r < 0) {
        SETERRQ(PETSC_COMM_SELF, MOFEM_OPERATION_UNSUCCESSFUL,
                "ADOL-C function evaluation with error");
      }
    } else {
      diffC = 0;
    }
    MoFEMFunctionReturnHot(0);
  }

calDiffK()

MoFEMErrorCode MixTransport::MaterialWithAutomaticDifferentiation::calDiffK ( )

inlinevirtual

Reimplemented from MixTransport::GenericMaterial.

Definition at line 178 of file MaterialUnsaturatedFlow.hpp.

                            {
    MoFEMFunctionBeginHot;
    if (h < hS) {
      diffK = 0;
      int r = ::gradient(2 * blockId + 1, 1, &h, &diffKr);
      if (r < 0) {
        SETERRQ(PETSC_COMM_SELF, MOFEM_OPERATION_UNSUCCESSFUL,
                "ADOL-C function evaluation with error");
      }
      diffK = Ks * diffKr;
    } else {
      diffK = 0;
    }
    MoFEMFunctionReturnHot(0);
  };

calK()

MoFEMErrorCode MixTransport::MaterialWithAutomaticDifferentiation::calK ( )

inlinevirtual

Reimplemented from MixTransport::GenericMaterial.

Definition at line 161 of file MaterialUnsaturatedFlow.hpp.

                        {
    MoFEMFunctionBeginHot;
    if (h < hS) {
      int r = ::function(2 * blockId + 1, 1, 1, &h, &Kr);
      if (r < 0) {
        SETERRQ(PETSC_COMM_SELF, MOFEM_OPERATION_UNSUCCESSFUL,
                "ADOL-C function evaluation with error");
      }
      K = Ks * Kr;
    } else {
      K = Ks;
    }
    K += Ks * ePsilon0;
    MoFEMFunctionReturnHot(0);
  };

calSe()

MoFEMErrorCode MixTransport::MaterialWithAutomaticDifferentiation::calSe ( )

inlinevirtual

Reimplemented from MixTransport::GenericMaterial.

Definition at line 238 of file MaterialUnsaturatedFlow.hpp.

                         {
    MoFEMFunctionBeginHot;
    if (h < hS) {
      int r = ::function(2 * blockId + 0, 1, 1, &h, &tHeta);
      Se = funSe(tHeta);
      if (r < 0) {
        SETERRQ(PETSC_COMM_SELF, MOFEM_OPERATION_UNSUCCESSFUL,
                "ADOL-C function evaluation with error");
      }
    } else {
      tHeta = thetaS;
    }
    MoFEMFunctionReturnHot(0);
  }

calTheta()

MoFEMErrorCode MixTransport::MaterialWithAutomaticDifferentiation::calTheta ( )

inlinevirtual

Reimplemented from MixTransport::GenericMaterial.

Definition at line 224 of file MaterialUnsaturatedFlow.hpp.

                            {
    MoFEMFunctionBeginHot;
    if (h < hS) {
      int r = ::function(2 * blockId + 0, 1, 1, &h, &tHeta);
      if (r < 0) {
        SETERRQ(PETSC_COMM_SELF, MOFEM_OPERATION_UNSUCCESSFUL,
                "ADOL-C function evaluation with error");
      }
    } else {
      tHeta = thetaS;
    }
    MoFEMFunctionReturnHot(0);
  }

funSe()

template<typename TYPE >

TYPE MixTransport::MaterialWithAutomaticDifferentiation::funSe ( TYPE &  theta )

inline

Definition at line 152 of file MaterialUnsaturatedFlow.hpp.

                                                          {
    return (theta - thetaR) / (thetaS - thetaR);
  }

recordKr()

virtual void MixTransport::MaterialWithAutomaticDifferentiation::recordKr ( )

pure virtual

Implemented in MixTransport::MaterialVanGenuchten.

recordTheta()

virtual void MixTransport::MaterialWithAutomaticDifferentiation::recordTheta ( )

pure virtual

Implemented in MixTransport::MaterialVanGenuchten.

Member Data Documentation

diffKr

double MixTransport::MaterialWithAutomaticDifferentiation::diffKr

Definition at line 175 of file MaterialUnsaturatedFlow.hpp.

Kr

double MixTransport::MaterialWithAutomaticDifferentiation::Kr

Definition at line 160 of file MaterialUnsaturatedFlow.hpp.

---

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

• users_modules/tutorials/cor-0to1/src/MaterialUnsaturatedFlow.hpp