INSADBoussinesqBodyForce.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 "INSADBoussinesqBodyForce.h"
#include "INSADObjectTracker.h"
#include "FEProblemBase.h"

registerMooseObject("NavierStokesApp", INSADBoussinesqBodyForce);

InputParameters
INSADBoussinesqBodyForce::validParams()
{
  InputParameters params = ADVectorKernelValue::validParams();
  params.addClassDescription("Computes a body force for natural convection buoyancy.");
  params.addRequiredCoupledVar("temperature", "temperature variable, for off diagonal jacobian");
  params.addRequiredParam<RealVectorValue>("gravity", "Direction of the gravity vector");
  params.addParam<MaterialPropertyName>("alpha_name",
                                        "alpha",
                                        "The name of the thermal expansion coefficient"
                                        "this is of the form rho = rho*(1-alpha (T-T_ref))");
  params.addParam<MaterialPropertyName>(
      "ref_temp", "temp_ref", "The name of the reference temperature");
  return params;
}

INSADBoussinesqBodyForce::INSADBoussinesqBodyForce(const InputParameters & parameters)
  : ADVectorKernelValue(parameters),
    _boussinesq_strong_residual(
        getADMaterialProperty<RealVectorValue>("boussinesq_strong_residual"))
{
  if (coupledComponents("temperature") != 1)
    paramError("temperature", "Only one variable should be used for 'temperature'");

  if (_tid == 0)
  {
    // Bypass the UserObjectInterface method because it requires a UserObjectName param which we
    // don't need
    auto & obj_tracker = _fe_problem.getUserObject<INSADObjectTracker>("ins_ad_object_tracker");

    const auto alpha_name = getMaterialPropertyName("alpha_name");
    const auto ref_temp = getMaterialPropertyName("ref_temp");

    for (const auto block_id : blockIDs())
    {
      obj_tracker.set("has_boussinesq", true, block_id);

      // We actually want to perform the material property requests during object construction in
      // order to ensure that material property dependency is recorded correctly (I don't think this
      // should actually matter for non-Material MaterialPropertyInterface classes, but might as
      // well be consistent)
      obj_tracker.set("alpha", alpha_name, block_id);
      obj_tracker.set("ref_temp", ref_temp, block_id);

      obj_tracker.set("temperature", getVar("temperature", 0)->name(), block_id);
      obj_tracker.set("gravity", getParam<RealVectorValue>("gravity"), block_id);
    }
  }
}

ADRealVectorValue
INSADBoussinesqBodyForce::precomputeQpResidual()
{
  return _boussinesq_strong_residual[_qp];
}