Couples to some other value and modulates it by the mesh height in a direction. More...

#include <CoupledDirectionalMeshHeightInterpolation.h>

Inheritance diagram for CoupledDirectionalMeshHeightInterpolation:

Public Member Functions
	CoupledDirectionalMeshHeightInterpolation (const InputParameters &parameters)
	Factory constructor, takes parameters so that all derived classes can be built using the same constructor. More...

virtual	~CoupledDirectionalMeshHeightInterpolation ()

Protected Member Functions
virtual Real	computeValue ()

Protected Attributes
const VariableValue &	_coupled_val
	The value of a coupled variable to modulate. More...

unsigned int	_direction
	The direction to interpolate in. More...

Real	_direction_min

Real	_direction_max

Detailed Description

Couples to some other value and modulates it by the mesh height in a direction.

What this means is that a constant field will become a linear field that is zero at the end of the domain that is most negative in the given direction and is that given constant value at the extremum of the mesh in the given direction.

This can be useful for specifying linear mesh "stretches". If you are wanting to stretch a mesh by "5"... put 5 into the field that this couples to and this AuxKernel can create a linear "displacement" field that will give that stretch.

Definition at line 31 of file CoupledDirectionalMeshHeightInterpolation.h.

Constructor & Destructor Documentation

◆ CoupledDirectionalMeshHeightInterpolation()

CoupledDirectionalMeshHeightInterpolation::CoupledDirectionalMeshHeightInterpolation ( const InputParameters & parameters )

Factory constructor, takes parameters so that all derived classes can be built using the same constructor.

Definition at line 31 of file CoupledDirectionalMeshHeightInterpolation.C.

   : AuxKernel(parameters),
     _coupled_val(coupledValue("coupled_var")),
     _direction(getParam<MooseEnum>("direction"))
 {
   BoundingBox bounding_box = MeshTools::create_bounding_box(_subproblem.mesh());
  
   _direction_min = bounding_box.min()(_direction);
   _direction_max = bounding_box.max()(_direction);
 }

◆ ~CoupledDirectionalMeshHeightInterpolation()

virtual CoupledDirectionalMeshHeightInterpolation::~CoupledDirectionalMeshHeightInterpolation ( )

inlinevirtual

Definition at line 40 of file CoupledDirectionalMeshHeightInterpolation.h.

40 {}

Member Function Documentation

◆ computeValue()

Real CoupledDirectionalMeshHeightInterpolation::computeValue ( )

protectedvirtual

Definition at line 44 of file CoupledDirectionalMeshHeightInterpolation.C.

 {
   const Node & current_pos = *_current_node;
  
   Real percentage_along_direction =
       (current_pos(_direction) - _direction_min) / (_direction_max - _direction_min);
  
   return percentage_along_direction * _coupled_val[_qp];
 }