DerivativeMaterialPropertyNameInterface.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 "MooseTypes.h"
#include "MooseError.h"

#define usingDerivativeMaterialPropertyNameInterfaceMembers                                        \
  using DerivativeMaterialPropertyNameInterface::derivativePropertyName;                           \
  using DerivativeMaterialPropertyNameInterface::derivativePropertyNameFirst;                      \
  using DerivativeMaterialPropertyNameInterface::derivativePropertyNameSecond;                     \
  using DerivativeMaterialPropertyNameInterface::derivativePropertyNameThird

class DerivativeMaterialPropertyNameInterface
{
public:
  typedef std::string SymbolName;

  const MaterialPropertyName derivativePropertyName(const MaterialPropertyName & base,
                                                    const std::vector<SymbolName> & c) const;

  const MaterialPropertyName derivativePropertyNameFirst(const MaterialPropertyName & base,
                                                         const SymbolName & c1) const;

  const MaterialPropertyName derivativePropertyNameSecond(const MaterialPropertyName & base,
                                                          const SymbolName & c1,
                                                          const SymbolName & c2) const;

  const MaterialPropertyName derivativePropertyNameThird(const MaterialPropertyName & base,
                                                         const SymbolName & c1,
                                                         const SymbolName & c2,
                                                         const SymbolName & c3) const;

  const MaterialPropertyName propertyName(const MaterialPropertyName & base,
                                          const std::vector<SymbolName> & c) const
  {
    mooseDeprecated("This function was renamed to 'derivativePropertyName'");
    return derivativePropertyName(base, c);
  }
  const MaterialPropertyName propertyNameFirst(const MaterialPropertyName & base,
                                               const SymbolName & c1) const
  {
    mooseDeprecated("This function was renamed to 'derivativePropertyNameFirst'");
    return derivativePropertyNameFirst(base, c1);
  }
  const MaterialPropertyName propertyNameSecond(const MaterialPropertyName & base,
                                                const SymbolName & c1,
                                                const SymbolName & c2) const
  {
    mooseDeprecated("This function was renamed to 'derivativePropertyNameSecond'");
    return derivativePropertyNameSecond(base, c1, c2);
  }
  const MaterialPropertyName propertyNameThird(const MaterialPropertyName & base,
                                               const SymbolName & c1,
                                               const SymbolName & c2,
                                               const SymbolName & c3) const
  {
    mooseDeprecated("This function was renamed to 'derivativePropertyNameThird'");
    return derivativePropertyNameThird(base, c1, c2, c3);
  }
};