DerivativeFunctionMaterialBase.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html
 
#pragma once
 
#include "FunctionMaterialBase.h"
 
#define usingDerivativeFunctionMaterialBaseMembers(T)                                              \
  usingFunctionMaterialBaseMembers(T);                                                             \
  using DerivativeFunctionMaterialBaseTempl<T>::computeF;                                          \
  using DerivativeFunctionMaterialBaseTempl<T>::computeDF;                                         \
  using DerivativeFunctionMaterialBaseTempl<T>::computeD2F;                                        \
  using DerivativeFunctionMaterialBaseTempl<T>::computeD3F;                                        \
  using DerivativeFunctionMaterialBaseTempl<T>::_third_derivatives;                                \
  using DerivativeFunctionMaterialBaseTempl<T>::_prop_dF;                                          \
  using DerivativeFunctionMaterialBaseTempl<T>::_prop_d2F;                                         \
  using DerivativeFunctionMaterialBaseTempl<T>::_prop_d3F
 
template <bool is_ad = false>
class DerivativeFunctionMaterialBaseTempl : public FunctionMaterialBase<is_ad>
{
public:
  static InputParameters validParams();
 
  DerivativeFunctionMaterialBaseTempl(const InputParameters & parameters);
 
protected:
  usingFunctionMaterialBaseMembers(is_ad);
 
  void computeProperties() override;
 
  void initialSetup() override;
 
  virtual GenericReal<is_ad> computeF() { return 0.0; }
 
  virtual GenericReal<is_ad> computeDF(unsigned int arg)
  {
    libmesh_ignore(arg);
    return 0.0;
  }
 
  virtual GenericReal<is_ad> computeD2F(unsigned int arg1, unsigned int arg2)
  {
    libmesh_ignore(arg1);
    libmesh_ignore(arg2);
    return 0.0;
  }
 
  virtual GenericReal<is_ad> computeD3F(unsigned int, unsigned int, unsigned int) { return 0.0; }
 
  bool _third_derivatives;
 
  std::vector<GenericMaterialProperty<Real, is_ad> *> _prop_dF;
 
  std::vector<std::vector<GenericMaterialProperty<Real, is_ad> *>> _prop_d2F;
 
  std::vector<std::vector<std::vector<GenericMaterialProperty<Real, is_ad> *>>> _prop_d3F;
};
 
typedef DerivativeFunctionMaterialBaseTempl<false> DerivativeFunctionMaterialBase;
typedef DerivativeFunctionMaterialBaseTempl<true> ADDerivativeFunctionMaterialBase;