Calculate explicit derivative of free energy. More...

#include "users_modules/basic_finite_elements/src/NonLinearElasticElement.hpp"

Inheritance diagram for NonlinearElasticElement::OpJacobianEnergy:

Collaboration diagram for NonlinearElasticElement::OpJacobianEnergy:

Public Member Functions
	OpJacobianEnergy (const std::string field_name, BlockData &data, CommonData &common_data, int tag, bool gradient, bool hessian, bool ale, bool field_disp)

virtual bool	recordTagForIntegrationPoint (const int gg)
	Check if tape is recorded for given integration point.

virtual MoFEMErrorCode	calculateEnergy (const int gg)
	Calculate Paola-Kirchhoff I stress.

virtual MoFEMErrorCode	recordTag (const int gg)
	Record ADOL-C tape.

virtual MoFEMErrorCode	playTag (const int gg)
	Play ADOL-C tape.

MoFEMErrorCode	doWork (int row_side, EntityType row_type, EntitiesFieldData::EntData &row_data)

Public Member Functions inherited from MoFEM::VolumeElementForcesAndSourcesCore::UserDataOperator
int	getNumNodes ()
	get element number of nodes

const EntityHandle *	getConn ()
	get element connectivity

double	getVolume () const
	element volume (linear geometry)

double &	getVolume ()
	element volume (linear geometry)

FTensor::Tensor2< double *, 3, 3 > &	getJac ()
	get element Jacobian

FTensor::Tensor2< double *, 3, 3 > &	getInvJac ()
	get element inverse Jacobian

VectorDouble &	getCoords ()
	nodal coordinates

VolumeElementForcesAndSourcesCore *	getVolumeFE () const
	return pointer to Generic Volume Finite Element object

Public Member Functions inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
	UserDataOperator (const FieldSpace space, const char type=OPSPACE, const bool symm=true)
	Constructor for operators working on finite element spaces.

	UserDataOperator (const std::string field_name, const char type, const bool symm=true)
	Constructor for operators working on a single field.

	UserDataOperator (const std::string row_field_name, const std::string col_field_name, const char type, const bool symm=true)
	Constructor for operators working on two fields (bilinear forms)

boost::shared_ptr< const NumeredEntFiniteElement >	getNumeredEntFiniteElementPtr () const
	Return raw pointer to NumeredEntFiniteElement.

EntityHandle	getFEEntityHandle () const
	Return finite element entity handle.

int	getFEDim () const
	Get dimension of finite element.

EntityType	getFEType () const
	Get dimension of finite element.

boost::weak_ptr< SideNumber >	getSideNumberPtr (const int side_number, const EntityType type)
	Get the side number pointer.

EntityHandle	getSideEntity (const int side_number, const EntityType type)
	Get the side entity.

int	getNumberOfNodesOnElement () const
	Get the number of nodes on finite element.

MoFEMErrorCode	getProblemRowIndices (const std::string filed_name, const EntityType type, const int side, VectorInt &indices) const
	Get row indices.

MoFEMErrorCode	getProblemColIndices (const std::string filed_name, const EntityType type, const int side, VectorInt &indices) const
	Get col indices.

const FEMethod *	getFEMethod () const
	Return raw pointer to Finite Element Method object.

int	getOpType () const
	Get operator types.

void	setOpType (const OpType type)
	Set operator type.

void	addOpType (const OpType type)
	Add operator type.

int	getNinTheLoop () const
	get number of finite element in the loop

int	getLoopSize () const
	get size of elements in the loop

std::string	getFEName () const
	Get name of the element.

ForcesAndSourcesCore *	getPtrFE () const

ForcesAndSourcesCore *	getSidePtrFE () const

ForcesAndSourcesCore *	getRefinePtrFE () const

const PetscData::Switches &	getDataCtx () const

const KspMethod::KSPContext	getKSPCtx () const

const SnesMethod::SNESContext	getSNESCtx () const

const TSMethod::TSContext	getTSCtx () const

Vec	getKSPf () const

Mat	getKSPA () const

Mat	getKSPB () const

Vec	getSNESf () const

Vec	getSNESx () const

Mat	getSNESA () const

Mat	getSNESB () const

Vec	getTSu () const

Vec	getTSu_t () const

Vec	getTSu_tt () const

Vec	getTSf () const

Mat	getTSA () const

Mat	getTSB () const

int	getTSstep () const

double	getTStime () const

double	getTStimeStep () const

double	getTSa () const

double	getTSaa () const

MatrixDouble &	getGaussPts ()
	matrix of integration (Gauss) points for Volume Element

auto	getFTensor0IntegrationWeight ()
	Get integration weights.

MatrixDouble &	getCoordsAtGaussPts ()
	Gauss points and weight, matrix (nb. of points x 3)

auto	getFTensor1CoordsAtGaussPts ()
	Get coordinates at integration points assuming linear geometry.

double	getMeasure () const
	get measure of element

double &	getMeasure ()
	get measure of element

MoFEMErrorCode	loopSide (const string &fe_name, ForcesAndSourcesCore side_fe, const size_t dim, const EntityHandle ent_for_side=0, boost::shared_ptr< Range > fe_range=nullptr, const int verb=QUIET, const LogManager::SeverityLevel sev=Sev::noisy, AdjCache adj_cache=nullptr)
	User calls this function to loop over elements on the side of face. This function calls finite element with its operator to do calculations.

MoFEMErrorCode	loopThis (const string &fe_name, ForcesAndSourcesCore *this_fe, const int verb=QUIET, const LogManager::SeverityLevel sev=Sev::noisy)
	User calls this function to loop over the same element using a different set of integration points. This function calls finite element with its operator to do calculations.

MoFEMErrorCode	loopParent (const string &fe_name, ForcesAndSourcesCore *parent_fe, const int verb=QUIET, const LogManager::SeverityLevel sev=Sev::noisy)
	User calls this function to loop over parent elements. This function calls finite element with its operator to do calculations.

MoFEMErrorCode	loopChildren (const string &fe_name, ForcesAndSourcesCore *child_fe, const int verb=QUIET, const LogManager::SeverityLevel sev=Sev::noisy)
	User calls this function to loop over parent elements. This function calls finite element with its operator to do calculations.

MoFEMErrorCode	loopRange (const string &fe_name, ForcesAndSourcesCore *range_fe, boost::shared_ptr< Range > fe_range, const int verb=QUIET, const LogManager::SeverityLevel sev=Sev::noisy)
	Iterate over range of elements.

Public Member Functions inherited from MoFEM::DataOperator
	DataOperator (const bool symm=true)

virtual	~DataOperator ()=default

virtual MoFEMErrorCode	doWork (int row_side, int col_side, EntityType row_type, EntityType col_type, EntitiesFieldData::EntData &row_data, EntitiesFieldData::EntData &col_data)
	Operator for bi-linear form, usually to calculate values on left hand side.

virtual MoFEMErrorCode	opLhs (EntitiesFieldData &row_data, EntitiesFieldData &col_data)

virtual MoFEMErrorCode	doWork (int side, EntityType type, EntitiesFieldData::EntData &data)
	Operator for linear form, usually to calculate values on right hand side.

virtual MoFEMErrorCode	opRhs (EntitiesFieldData &data, const bool error_if_no_base=false)

bool	getSymm () const
	Get if operator uses symmetry of DOFs or not.

void	setSymm ()
	set if operator is executed taking in account symmetry

void	unSetSymm ()
	unset if operator is executed for non symmetric problem

Public Attributes
BlockData &	dAta

CommonData &	commonData

int	tAg
	tape tag

bool	gRadient
	if set true gradient of energy is calculated

bool	hEssian
	if set true hessian of energy is calculated

bool	aLe
	true if arbitrary Lagrangian-Eulerian formulation

bool	fieldDisp
	true if displacements instead spatial positions used

VectorDouble	activeVariables

int	nbActiveVariables

std::vector< MatrixDouble > *	ptrh

std::vector< MatrixDouble > *	ptrH

FTensor::Index< 'i', 3 >	i

FTensor::Index< 'j', 3 >	j

FTensor::Index< 'k', 3 >	k

Public Attributes inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
char	opType

std::string	rowFieldName

std::string	colFieldName

FieldSpace	sPace

Public Attributes inherited from MoFEM::DataOperator
DoWorkLhsHookFunType	doWorkLhsHook

DoWorkRhsHookFunType	doWorkRhsHook

bool	sYmm
	If true assume that matrix is symmetric structure.

std::array< bool, MBMAXTYPE >	doEntities
	If true operator is executed for entity.

bool &	doVertices
	\deprectaed If false skip vertices

bool &	doEdges
	\deprectaed If false skip edges

bool &	doQuads
	\deprectaed

bool &	doTris
	\deprectaed

bool &	doTets
	\deprectaed

bool &	doPrisms
	\deprectaed

Additional Inherited Members
Public Types inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
enum	OpType { OPROW = 1 << 0 , OPCOL = 1 << 1 , OPROWCOL = 1 << 2 , OPSPACE = 1 << 3 , OPLAST = 1 << 3 }
	Controls loop over entities on element. More...

using	AdjCache = std::map< EntityHandle, std::vector< boost::weak_ptr< NumeredEntFiniteElement > > >

Public Types inherited from MoFEM::DataOperator
using	DoWorkLhsHookFunType = boost::function< MoFEMErrorCode(DataOperator *op_ptr, int row_side, int col_side, EntityType row_type, EntityType col_type, EntitiesFieldData::EntData &row_data, EntitiesFieldData::EntData &col_data)>

using	DoWorkRhsHookFunType = boost::function< MoFEMErrorCode(DataOperator *op_ptr, int side, EntityType type, EntitiesFieldData::EntData &data)>

Static Public Attributes inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
static const char *const	OpTypeNames []

Protected Member Functions inherited from MoFEM::VolumeElementForcesAndSourcesCore::UserDataOperator
MoFEMErrorCode	setPtrFE (ForcesAndSourcesCore *ptr)

Protected Attributes inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
ForcesAndSourcesCore *	ptrFE

Detailed Description

Calculate explicit derivative of free energy.

Definition at line 459 of file NonLinearElasticElement.hpp.

Constructor & Destructor Documentation

◆ OpJacobianEnergy()

NonlinearElasticElement::OpJacobianEnergy::OpJacobianEnergy	(	const std::string	field_name,
		BlockData &	data,
		CommonData &	common_data,
		int	tag,
		bool	gradient,
		bool	hessian,
		bool	ale,
		bool	field_disp
	)

Parameters

field_name field name for spatial positions or displacements

Definition at line 410 of file NonLinearElasticElement.cpp.

    : VolumeElementForcesAndSourcesCore::UserDataOperator(
          field_name, UserDataOperator::OPROW),
      dAta(data), commonData(common_data), tAg(tag), gRadient(gradient),
      hEssian(hessian), aLe(ale), fieldDisp(field_disp) {}

Member Function Documentation

◆ calculateEnergy()

MoFEMErrorCode NonlinearElasticElement::OpJacobianEnergy::calculateEnergy ( const int gg )

virtual

Calculate Paola-Kirchhoff I stress.

Returns: error code

Definition at line 421 of file NonLinearElasticElement.cpp.

                                                                     {
  MoFEMFunctionBegin;
  CHKERR dAta.materialAdoublePtr->calculateElasticEnergy(
      dAta, getNumeredEntFiniteElementPtr());
  dAta.materialAdoublePtr->eNergy >>= commonData.eNergy[gg];
  MoFEMFunctionReturn(0);
}

◆ doWork()

MoFEMErrorCode NonlinearElasticElement::OpJacobianEnergy::doWork	(	int	row_side,
		EntityType	row_type,
		EntitiesFieldData::EntData &	row_data
	)

Definition at line 527 of file NonLinearElasticElement.cpp.

                                        {
  MoFEMFunctionBegin;
 
  // do it only once, no need to repeat this for edges,faces or tets
  if (row_type != MBVERTEX)
    MoFEMFunctionReturnHot(0);
 
  if (dAta.tEts.find(getNumeredEntFiniteElementPtr()->getEnt()) ==
      dAta.tEts.end()) {
    MoFEMFunctionReturnHot(0);
  }
 
  int nb_dofs = row_data.getFieldData().size();
  if (nb_dofs == 0)
    MoFEMFunctionReturnHot(0);
  dAta.materialAdoublePtr->commonDataPtr = &commonData;
  dAta.materialAdoublePtr->opPtr = this;
 
  int nb_gauss_pts = row_data.getN().size1();
  commonData.eNergy.resize(nb_gauss_pts);
  commonData.jacEnergy.resize(nb_gauss_pts);
 
  ptrh = &(commonData.gradAtGaussPts[commonData.spatialPositions]);
  if (aLe) {
    ptrH = &(commonData.gradAtGaussPts[commonData.meshPositions]);
  }
 
  for (int gg = 0; gg != nb_gauss_pts; gg++) {
 
    dAta.materialAdoublePtr->gG = gg;
 
    // Record tag and calualte stress
    if (recordTagForIntegrationPoint(gg)) {
      CHKERR recordTag(gg);
    }
 
    activeVariables.resize(nbActiveVariables, false);
    if (!aLe) {
      for (int dd1 = 0; dd1 < 3; dd1++) {
        for (int dd2 = 0; dd2 < 3; dd2++) {
          activeVariables(dd1 * 3 + dd2) = (*ptrh)[gg](dd1, dd2);
        }
      }
    } else {
      for (int dd1 = 0; dd1 < 3; dd1++) {
        for (int dd2 = 0; dd2 < 3; dd2++) {
          activeVariables(dd1 * 3 + dd2) = (*ptrh)[gg](dd1, dd2);
        }
      }
      for (int dd1 = 0; dd1 < 3; dd1++) {
        for (int dd2 = 0; dd2 < 3; dd2++) {
          activeVariables(9 + dd1 * 3 + dd2) = (*ptrH)[gg](dd1, dd2);
        }
      }
    }
    CHKERR dAta.materialAdoublePtr->setUserActiveVariables(activeVariables);
 
    // Play tag and calculate stress or tangent
    CHKERR playTag(gg);
  }
 
  MoFEMFunctionReturn(0);
}

◆ playTag()

MoFEMErrorCode NonlinearElasticElement::OpJacobianEnergy::playTag ( const int gg )

virtual

Play ADOL-C tape.

Returns: error code

Definition at line 493 of file NonLinearElasticElement.cpp.

                                                             {
  MoFEMFunctionBegin;
 
  if (gRadient) {
    commonData.jacEnergy[gg].resize(nbActiveVariables, false);
    int r = ::gradient(tAg, nbActiveVariables, &activeVariables[0],
                       &commonData.jacEnergy[gg][0]);
    if (r < 0) {
      // That means that energy function is not smooth and derivative
      // can not be calculated,
      SETERRQ(PETSC_COMM_SELF, MOFEM_OPERATION_UNSUCCESSFUL,
              "ADOL-C function evaluation with error");
    }
  }
 
  if (hEssian) {
    commonData.hessianEnergy[gg].resize(nbActiveVariables * nbActiveVariables,
                                        false);
    double *H[nbActiveVariables];
    for (int n = 0; n != nbActiveVariables; n++) {
      H[n] = &(commonData.hessianEnergy[gg][n * nbActiveVariables]);
    }
    int r = ::hessian(tAg, nbActiveVariables, &*activeVariables.begin(), H);
    if (r < 0) {
      // That means that energy function is not smooth and derivative
      // can not be calculated,
      SETERRQ(PETSC_COMM_SELF, MOFEM_OPERATION_UNSUCCESSFUL,
              "ADOL-C function evaluation with error");
    }
  }
 
  MoFEMFunctionReturn(0);
}

◆ recordTag()

MoFEMErrorCode NonlinearElasticElement::OpJacobianEnergy::recordTag ( const int gg )

virtual

Record ADOL-C tape.

Returns: error code

Definition at line 430 of file NonLinearElasticElement.cpp.

                                                               {
  MoFEMFunctionBegin;
 
  trace_on(tAg, 0);
 
  if (!aLe) {
 
    nbActiveVariables = 0;
    for (int dd1 = 0; dd1 < 3; dd1++) {
      for (int dd2 = 0; dd2 < 3; dd2++) {
        dAta.materialAdoublePtr->F(dd1, dd2) <<= (*ptrh)[gg](dd1, dd2);
        if (fieldDisp) {
          if (dd1 == dd2) {
            dAta.materialAdoublePtr->F(dd1, dd2) += 1;
          }
        }
        nbActiveVariables++;
      }
    }
 
  } else {
 
    nbActiveVariables = 0;
 
    dAta.materialAdoublePtr->h.resize(3, 3, false);
    for (int dd1 = 0; dd1 < 3; dd1++) {
      for (int dd2 = 0; dd2 < 3; dd2++) {
        dAta.materialAdoublePtr->h(dd1, dd2) <<= (*ptrh)[gg](dd1, dd2);
        nbActiveVariables++;
      }
    }
 
    dAta.materialAdoublePtr->H.resize(3, 3, false);
    for (int dd1 = 0; dd1 < 3; dd1++) {
      for (int dd2 = 0; dd2 < 3; dd2++) {
        dAta.materialAdoublePtr->H(dd1, dd2) <<= (*ptrH)[gg](dd1, dd2);
        nbActiveVariables++;
      }
    }
 
    dAta.materialAdoublePtr->detH = determinantTensor3by3(dAta.materialAdoublePtr->H);
    dAta.materialAdoublePtr->invH.resize(3, 3, false);
    CHKERR invertTensor3by3(dAta.materialAdoublePtr->H,
                            dAta.materialAdoublePtr->detH,
                            dAta.materialAdoublePtr->invH);
 
    auto &t_F = dAta.materialAdoublePtr->t_F;
    auto &t_h = dAta.materialAdoublePtr->t_h;
    auto &t_invH = dAta.materialAdoublePtr->t_invH;
 
    t_F(i, j) = t_h(i, k) * t_invH(k, j);
 
  }
 
  CHKERR dAta.materialAdoublePtr->setUserActiveVariables(nbActiveVariables);
  CHKERR calculateEnergy(gg);
 
  trace_off();
 
  MoFEMFunctionReturn(0);
}

◆ recordTagForIntegrationPoint()

virtual bool NonlinearElasticElement::OpJacobianEnergy::recordTagForIntegrationPoint ( const int gg )

inlinevirtual

Check if tape is recorded for given integration point.

Parameters

gg	integration point

Returns: true if tag is recorded

Definition at line 492 of file NonLinearElasticElement.hpp.

                                                            {
      if (gg == 0)
        return true;
      return false;
    }

Member Data Documentation

◆ activeVariables

VectorDouble NonlinearElasticElement::OpJacobianEnergy::activeVariables

Definition at line 477 of file NonLinearElasticElement.hpp.

◆ aLe

bool NonlinearElasticElement::OpJacobianEnergy::aLe

true if arbitrary Lagrangian-Eulerian formulation

Definition at line 468 of file NonLinearElasticElement.hpp.

◆ commonData

CommonData& NonlinearElasticElement::OpJacobianEnergy::commonData

Definition at line 463 of file NonLinearElasticElement.hpp.

◆ dAta

BlockData& NonlinearElasticElement::OpJacobianEnergy::dAta

Definition at line 462 of file NonLinearElasticElement.hpp.

◆ fieldDisp

bool NonlinearElasticElement::OpJacobianEnergy::fieldDisp

true if displacements instead spatial positions used

Definition at line 469 of file NonLinearElasticElement.hpp.

◆ gRadient

bool NonlinearElasticElement::OpJacobianEnergy::gRadient

if set true gradient of energy is calculated

Definition at line 466 of file NonLinearElasticElement.hpp.

◆ hEssian

bool NonlinearElasticElement::OpJacobianEnergy::hEssian

if set true hessian of energy is calculated

Definition at line 467 of file NonLinearElasticElement.hpp.

◆ i

FTensor::Index<'i', 3> NonlinearElasticElement::OpJacobianEnergy::i

Definition at line 483 of file NonLinearElasticElement.hpp.

◆ j

FTensor::Index<'j', 3> NonlinearElasticElement::OpJacobianEnergy::j

Definition at line 484 of file NonLinearElasticElement.hpp.

◆ k

FTensor::Index<'k', 3> NonlinearElasticElement::OpJacobianEnergy::k

Definition at line 485 of file NonLinearElasticElement.hpp.

◆ nbActiveVariables

int NonlinearElasticElement::OpJacobianEnergy::nbActiveVariables

Definition at line 478 of file NonLinearElasticElement.hpp.

◆ ptrh

std::vector<MatrixDouble>* NonlinearElasticElement::OpJacobianEnergy::ptrh

Definition at line 480 of file NonLinearElasticElement.hpp.

◆ ptrH

std::vector<MatrixDouble>* NonlinearElasticElement::OpJacobianEnergy::ptrH

Definition at line 481 of file NonLinearElasticElement.hpp.

◆ tAg

int NonlinearElasticElement::OpJacobianEnergy::tAg

tape tag

Definition at line 465 of file NonLinearElasticElement.hpp.

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

users_modules/basic_finite_elements/src/NonLinearElasticElement.hpp
users_modules/basic_finite_elements/src/impl/NonLinearElasticElement.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OpJacobianEnergy()

Member Function Documentation

◆ calculateEnergy()

◆ doWork()

◆ playTag()

◆ recordTag()

◆ recordTagForIntegrationPoint()

Member Data Documentation

◆ activeVariables

◆ aLe

◆ commonData

◆ dAta

◆ fieldDisp

◆ gRadient

◆ hEssian

◆ i

◆ j

◆ k

◆ nbActiveVariables

◆ ptrh

◆ ptrH

◆ tAg