https://mooseframework.inl.gov
DerivativeMaterialPropertyNameInterface.h
Go to the documentation of this file.
1 
2 //* This file is part of the MOOSE framework
3 //* https://mooseframework.inl.gov
4 //*
5 //* All rights reserved, see COPYRIGHT for full restrictions
6 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
7 //*
8 //* Licensed under LGPL 2.1, please see LICENSE for details
9 //* https://www.gnu.org/licenses/lgpl-2.1.html
10 
11 #pragma once
12 
13 #include "MooseTypes.h"
14 #include "MooseError.h"
15 
16 #define usingDerivativeMaterialPropertyNameInterfaceMembers \
17  using DerivativeMaterialPropertyNameInterface::derivativePropertyName; \
18  using DerivativeMaterialPropertyNameInterface::derivativePropertyNameFirst; \
19  using DerivativeMaterialPropertyNameInterface::derivativePropertyNameSecond; \
20  using DerivativeMaterialPropertyNameInterface::derivativePropertyNameThird
21 
23 {
24 public:
25  typedef std::string SymbolName;
26 
31  const MaterialPropertyName derivativePropertyName(const MaterialPropertyName & base,
32  const std::vector<SymbolName> & c) const;
33 
38  const MaterialPropertyName derivativePropertyNameFirst(const MaterialPropertyName & base,
39  const SymbolName & c1) const;
40 
45  const MaterialPropertyName derivativePropertyNameSecond(const MaterialPropertyName & base,
46  const SymbolName & c1,
47  const SymbolName & c2) const;
48 
53  const MaterialPropertyName derivativePropertyNameThird(const MaterialPropertyName & base,
54  const SymbolName & c1,
55  const SymbolName & c2,
56  const SymbolName & c3) const;
57 
59  const MaterialPropertyName propertyName(const MaterialPropertyName & base,
60  const std::vector<SymbolName> & c) const
61  {
62  mooseDeprecated("This function was renamed to 'derivativePropertyName'");
63  return derivativePropertyName(base, c);
64  }
65  const MaterialPropertyName propertyNameFirst(const MaterialPropertyName & base,
66  const SymbolName & c1) const
67  {
68  mooseDeprecated("This function was renamed to 'derivativePropertyNameFirst'");
69  return derivativePropertyNameFirst(base, c1);
70  }
71  const MaterialPropertyName propertyNameSecond(const MaterialPropertyName & base,
72  const SymbolName & c1,
73  const SymbolName & c2) const
74  {
75  mooseDeprecated("This function was renamed to 'derivativePropertyNameSecond'");
76  return derivativePropertyNameSecond(base, c1, c2);
77  }
78  const MaterialPropertyName propertyNameThird(const MaterialPropertyName & base,
79  const SymbolName & c1,
80  const SymbolName & c2,
81  const SymbolName & c3) const
82  {
83  mooseDeprecated("This function was renamed to 'derivativePropertyNameThird'");
84  return derivativePropertyNameThird(base, c1, c2, c3);
85  }
87 };
const MaterialPropertyName derivativePropertyNameSecond(const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
Helper functions to generate the material property names for the second derivatives.
const MaterialPropertyName derivativePropertyNameFirst(const MaterialPropertyName &base, const SymbolName &c1) const
Helper functions to generate the material property names for the first derivatives.
const MaterialPropertyName propertyNameFirst(const MaterialPropertyName &base, const SymbolName &c1) const
const MaterialPropertyName derivativePropertyName(const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
Helper functions to generate the material property names for the arbitrary derivatives.
void mooseDeprecated(Args &&... args)
Emit a deprecated code/feature message with the given stringified, concatenated args.
Definition: MooseError.h:353
const MaterialPropertyName propertyNameSecond(const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
const MaterialPropertyName propertyName(const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
aliases for the deprecated old function names
const MaterialPropertyName derivativePropertyNameThird(const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
Helper functions to generate the material property names for the third derivatives.
const MaterialPropertyName propertyNameThird(const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const