ADVolumeJunctionBaseUserObject.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 "ADFlowJunctionUserObject.h"

class ADVolumeJunctionBaseUserObject : public ADFlowJunctionUserObject
{
public:
  ADVolumeJunctionBaseUserObject(const InputParameters & params);

  virtual void initialSetup() override;
  virtual void initialize() override;
  virtual void execute() override;
  virtual void threadJoin(const UserObject & uo) override;

  const std::vector<ADReal> & getResidual() const;

  const std::vector<ADReal> & getFlux(const unsigned int & connection_index) const override;

protected:
  virtual void storeConnectionData();

  virtual void computeFluxesAndResiduals(const unsigned int & c) = 0;

  virtual std::vector<const MooseVariableBase *> getFlowChannelVariables() const;

  virtual std::vector<const MooseVariableBase *> getJunctionVariables() const;

  const MooseVariableBase * getJunctionVar(const std::string & var_name, unsigned int i = 0) const;

  const ADVariableValue & coupledJunctionValue(const std::string & var_name,
                                               unsigned int i = 0) const;

  const bool _use_scalar_variables;

  const subdomain_id_type _junction_subdomain_id;

  const Real & _volume;

  std::vector<std::string> _flow_variable_names;
  std::vector<std::string> _scalar_variable_names;

  unsigned int _n_flux_eq;
  unsigned int _n_scalar_eq;

  std::vector<const ADVariableValue *> _junction_var_values;
  std::vector<ADReal> _cached_junction_var_values;

  const std::vector<UserObjectName> & _numerical_flux_names;

  std::vector<unsigned int> _connection_indices;

  std::vector<dof_id_type> _scalar_dofs;
  std::vector<std::vector<dof_id_type>> _flow_channel_dofs;

  std::vector<std::vector<ADReal>> _flux;

  std::vector<ADReal> _residual;

public:
  static InputParameters validParams();
};