VectorBodyForce.C

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
 
#include "VectorBodyForce.h"
#include "Function.h"
 
registerMooseObject("MooseApp", VectorBodyForce);
 
InputParameters
VectorBodyForce::validParams()
{
  InputParameters params = VectorKernel::validParams();
  params.addClassDescription(
      "Demonstrates the multiple ways that scalar values can be introduced "
      "into kernels, e.g. (controllable) constants, functions, and "
      "postprocessors. Implements the weak form $(\\vec{\\psi_i}, -\\vec{f})$.");
  params.addParam<Real>("value", 1.0, "Coefficient to multiply by the body force term");
  params.addParam<FunctionName>("function",
                                "A function that defines a vectorValue method. This cannot be "
                                "supplied with the component parameters.");
  params.addParam<FunctionName>(
      "function_x", "1", "A function that describes the x-component of the body force");
  params.addParam<FunctionName>(
      "function_y", "0", "A function that describes the y-component of the body force");
  params.addParam<FunctionName>(
      "function_z", "0", "A function that describes the z-component of the body force");
  params.addParam<PostprocessorName>(
      "postprocessor", 1, "A postprocessor whose value is multiplied by the body force");
  params.declareControllable("value");
  return params;
}
 
VectorBodyForce::VectorBodyForce(const InputParameters & parameters)
  : VectorKernel(parameters),
    _scale(getParam<Real>("value")),
    _function(isParamValid("function") ? &getFunction("function") : nullptr),
    _function_x(getFunction("function_x")),
    _function_y(getFunction("function_y")),
    _function_z(getFunction("function_z")),
    _postprocessor(getPostprocessorValue("postprocessor"))
{
 
  if (_function && parameters.isParamSetByUser("function_x"))
    paramError("function_x", "The 'function' and 'function_x' parameters cannot both be set.");
  if (_function && parameters.isParamSetByUser("function_y"))
    paramError("function_y", "The 'function' and 'function_y' parameters cannot both be set.");
  if (_function && parameters.isParamSetByUser("function_z"))
    paramError("function_z", "The 'function' and 'function_z' parameters cannot both be set.");
}
 
Real
VectorBodyForce::computeQpResidual()
{
  Real factor = _scale * _postprocessor;
  if (_function)
    return _test[_i][_qp] * -factor * _function->vectorValue(_t, _q_point[_qp]);
  else
    return _test[_i][_qp] * -factor *
           RealVectorValue(_function_x.value(_t, _q_point[_qp]),
                           _function_y.value(_t, _q_point[_qp]),
                           _function_z.value(_t, _q_point[_qp]));
}