FVTimeKernel

construction:Undocumented Class

The FVTimeKernel has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.


# FVTimeKernel

!syntax description /FVKernels/FVTimeKernel

## Overview

!! Replace these lines with information regarding the FVTimeKernel object.

## Example Input File Syntax

!! Describe and include an example of how to use the FVTimeKernel object.

!syntax parameters /FVKernels/FVTimeKernel

!syntax inputs /FVKernels/FVTimeKernel

!syntax children /FVKernels/FVTimeKernel

Residual contribution from time derivative of a variable for the finite volume method.

Input Parameters

variableThe name of the finite volume variable this kernel applies to
C++ Type:NonlinearVariableName
Options:
Description:The name of the finite volume variable this kernel applies to

Required Parameters

blockThe list of block ids (SubdomainID) that this object will be applied
C++ Type:std::vector<SubdomainName>
Options:
Description:The list of block ids (SubdomainID) that this object will be applied
ghost_layers1The number of layers of elements to ghost.
Default:1
C++ Type:unsigned short
Options:
Description:The number of layers of elements to ghost.
use_point_neighborsFalseWhether to use point neighbors, which introduces additional ghosting to that used for simple face neighbors.
Default:False
C++ Type:bool
Options:
Description:Whether to use point neighbors, which introduces additional ghosting to that used for simple face neighbors.

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Options:
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.
implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Options:
Description:Determines whether this object is calculated using an implicit or explicit form
use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Default:False
C++ Type:bool
Options:
Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
C++ Type:std::vector<TagName>
Options:
Description:The extra tags for the matrices this Kernel should fill
extra_vector_tagsThe extra tags for the vectors this Kernel should fill
C++ Type:std::vector<TagName>
Options:
Description:The extra tags for the vectors this Kernel should fill
matrix_tagssystem timeThe tag for the matrices this Kernel should fill
Default:system time
C++ Type:MultiMooseEnum
Options:nontime, system, time
Description:The tag for the matrices this Kernel should fill
vector_tagstimeThe tag for the vectors this Kernel should fill
Default:time
C++ Type:MultiMooseEnum
Options:nontime, time
Description:The tag for the vectors this Kernel should fill

Tagging Parameters

Input Files

(test/tests/fvkernels/fv_constant_scalar_advection/2D_constant_scalar_advection.i)
(test/tests/fvkernels/fv_simple_diffusion/transient.i)
(test/tests/fvkernels/fv_burgers/fv_burgers.i)

Child Objects

(modules/navier_stokes/include/fvkernels/INSFVEnergyTimeDerivative.h)
(modules/navier_stokes/include/fvkernels/INSFVMomentumTimeDerivative.h)
(modules/navier_stokes/include/fvkernels/PINSFVEnergyTimeDerivative.h)

(test/tests/fvkernels/fv_constant_scalar_advection/2D_constant_scalar_advection.i)

[Mesh]
  [./gen_mesh]
    type = GeneratedMeshGenerator
    dim = 2
    xmin = 0
    xmax = 2
    ymin = 0
    ymax = 4
    nx = 10
    ny = 20
  [../]
[]

[Problem]
  kernel_coverage_check = off
[]

[Variables]
  [./v]
    family = MONOMIAL
    order = CONSTANT
    fv = true
  [../]
[]

[ICs]
  [./v_ic]
    type = FunctionIC
    variable = v
    function = 'r2 := (x - 0.5)*(x - 0.5) + (y - 0.3)*(y - 0.3); exp(-r2 * 20)'
  [../]
[]

[FVKernels]
  [./advection]
    type = FVAdvection
    variable = v
    velocity = '1 0.5 0'
  [../]
  [./time]
    type = FVTimeKernel
    variable = v
  [../]
[]

[FVBCs]
  [./fv_outflow]
    type = FVConstantScalarOutflowBC
    velocity = '1 0.5 0'
    variable = v
    boundary = 'right top'
  [../]
[]

[Executioner]
  type = Transient
  petsc_options = '-snes_converged_reason'
  num_steps = 10
  dt = 0.25
  nl_rel_tol = 1e-12
[]

[Outputs]
  exodus = true
[]

(test/tests/fvkernels/fv_simple_diffusion/transient.i)

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 10
  ny = 10
[]

[Variables]
  [v]
    family = MONOMIAL
    order = CONSTANT
    fv = true
    initial_condition = 7
  []
[]

[Kernels]
[]

[FVKernels]
  [./time]
    type = FVTimeKernel
    variable = v
  [../]
  [diff]
    type = FVDiffusion
    variable = v
    coeff = coeff
  []
[]

[FVBCs]
  [left]
    type = FVDirichletBC
    variable = v
    boundary = left
    value = 7
  []
  [right]
    type = FVDirichletBC
    variable = v
    boundary = right
    value = 42
  []
[]

[Materials]
  [diff]
    type = ADGenericConstantMaterial
    prop_names = 'coeff'
    prop_values = '.2'
  []
[]

[Problem]
  kernel_coverage_check = off
[]

[Executioner]
  type = Transient
  solve_type = 'PJFNK'
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
  num_steps = 20
  dt = 0.1
[]

[Outputs]
  exodus = true
[]

(test/tests/fvkernels/fv_burgers/fv_burgers.i)

[Mesh]
  [./gen_mesh]
    type = GeneratedMeshGenerator
    dim = 1
    xmin = 0
    xmax = 10
    nx = 50
  [../]
[]

[Variables]
  [./v]
    family = MONOMIAL
    order = CONSTANT
    fv = true
  [../]
[]

[ICs]
  [./v_ic]
    type = FunctionIC
    variable = v
    function = 'if (x > 2 & x < 3, 0.5, 0)'
  [../]
[]

[FVKernels]
  [./burgers]
    type = FVBurgers1D
    variable = v
  [../]
  [./time]
    type = FVTimeKernel
    variable = v
  [../]
[]

[FVBCs]
  [./fv_burgers_outflow]
    type = FVBurgersOutflowBC
    variable = v
    boundary = 'left right'
  [../]
[]

[Executioner]
  type = Transient
  petsc_options_iname = '-pc_type'
  petsc_options_value = 'lu'
  petsc_options = '-snes_converged_reason'
  nl_abs_tol = 1e-7
  nl_rel_tol = 1e-8
  num_steps = 5
  dt = 0.05
[]

[Outputs]
  exodus = true
[]

(modules/navier_stokes/include/fvkernels/INSFVEnergyTimeDerivative.h)

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// 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 "FVTimeKernel.h"

class INSFVEnergyTimeDerivative : public FVTimeKernel
{
public:
  static InputParameters validParams();
  INSFVEnergyTimeDerivative(const InputParameters & params);

protected:
  ADReal computeQpResidual() override;

  const Real & _rho;
  const ADMaterialProperty<Real> & _cp;
};

(modules/navier_stokes/include/fvkernels/INSFVMomentumTimeDerivative.h)

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// 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 "FVTimeKernel.h"

class INSFVMomentumTimeDerivative : public FVTimeKernel
{
public:
  static InputParameters validParams();
  INSFVMomentumTimeDerivative(const InputParameters & params);

protected:
  ADReal computeQpResidual() override;

  const Real & _rho;
};

(modules/navier_stokes/include/fvkernels/PINSFVEnergyTimeDerivative.h)

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// 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 "FVTimeKernel.h"

class PINSFVEnergyTimeDerivative : public FVTimeKernel
{
public:
  static InputParameters validParams();
  PINSFVEnergyTimeDerivative(const InputParameters & params);

protected:
  ADReal computeQpResidual() override;

  /// the density
  const Real & _rho;
  /// the heat conductivity
  const ADMaterialProperty<Real> & _cp;
  /// the porosity
  const VariableValue & _eps;
  /// whether this kernel is being used for a solid or a fluid temperature
  const bool _is_solid;
};

Input Parameters
Input Files
Child Objects

Install MOOSE

New Users

Examples and Tutorials

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools

INL Applications and Remote Access