ElementLpNormAux

under construction:Undocumented Class

The ElementLpNormAux 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.


# ElementLpNormAux

!syntax description /AuxKernels/ElementLpNormAux

## Overview

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

## Example Input File Syntax

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

!syntax parameters /AuxKernels/ElementLpNormAux

!syntax inputs /AuxKernels/ElementLpNormAux

!syntax children /AuxKernels/ElementLpNormAux

Compute an elemental field variable (single value per element) equal to the Lp-norm of a coupled Variable.

Input Parameters

coupled_variableThe variable to compute the norm of.
C++ Type:std::vector
Options:
Description:The variable to compute the norm of.
variableThe name of the variable that this object applies to
C++ Type:AuxVariableName
Options:
Description:The name of the variable that this object applies to

Required Parameters

blockThe list of block ids (SubdomainID) that this object will be applied
C++ Type:std::vector
Options:
Description:The list of block ids (SubdomainID) that this object will be applied
boundaryThe list of boundary IDs from the mesh where this boundary condition applies
C++ Type:std::vector
Options:
Description:The list of boundary IDs from the mesh where this boundary condition applies
execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
Default:LINEAR TIMESTEP_END
C++ Type:ExecFlagEnum
Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
p2The exponent used in the norm.
Default:2
C++ Type:double
Options:
Description:The exponent used in the norm.

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector
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.
seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Options:
Description:The seed for the master random number generator
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

Input Files

test/tests/auxkernels/error_function_aux/error_function_aux.i
test/tests/materials/material_dependency/diff_kernel_aux_mat_dep.i

test/tests/auxkernels/error_function_aux/error_function_aux.i

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

[Variables]
  [./u]
  [../]
[]

[AuxVariables]
  [./element_l2_error]
    # Aux field variable representing the L2 error on each element
    order = CONSTANT
    family = MONOMIAL
  [../]
  [./element_h1_error]
    # Aux field variable representing the H1 error on each element
    order = CONSTANT
    family = MONOMIAL
  [../]
  [./element_l2_norm]
    # Aux field variable representing the L^2 norm of the solution variable
    order = CONSTANT
    family = MONOMIAL
  [../]
[]

[Functions]
  [./exact_fn]
    type = ParsedFunction
    value = sin(2*pi*x)*sin(2*pi*y)
  [../]

  [./forcing_fn]
    type = ParsedFunction
    value = 8*pi^2*sin(2*pi*x)*sin(2*pi*y)
  [../]
[]

[Kernels]
  [./diff]
    type = Diffusion
    variable = u
  [../]
  [./ffn]
    type = BodyForce
    variable = u
    function = forcing_fn
  [../]
[]

[AuxKernels]
  [./l2_norm_aux]
    type = ElementLpNormAux
    variable = element_l2_norm
    coupled_variable = u
  [../]
  [./l2_error_aux]
    type = ElementL2ErrorFunctionAux
    variable = element_l2_error
    # A function representing the exact solution for the solution
    function = exact_fn
    # The nonlinear variable representing the FEM solution
    coupled_variable = u
  [../]
  [./h1_error_aux]
    type = ElementH1ErrorFunctionAux
    variable = element_h1_error
    # A function representing the exact solution for the solution
    function = exact_fn
    # The nonlinear variable representing the FEM solution
    coupled_variable = u
  [../]
[]

[BCs]
  [./all]
    type = FunctionDirichletBC
    variable = u
    boundary = 'bottom left right top'
    function = exact_fn
  [../]
[]

[Postprocessors]
  [./L2_error]
    # The L2 norm of the error over the entire mesh.  Note: this is
    # *not* equal to the sum over all the elements of the L2-error
    # norms.
    type = ElementL2Error
    variable = u
    function = exact_fn
  [../]
[]

[Executioner]
  type = Steady
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  exodus = true
[]

test/tests/materials/material_dependency/diff_kernel_aux_mat_dep.i

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

[Variables]
  [./u]
  [../]
[]

[Kernels]
  [./diff]
    type = MatDiffusionTest
    variable = u
    prop_name = 'diff'
  [../]
[]

[AuxKernels]
  [./error]
    type = ElementLpNormAux
    variable = error
    coupled_variable = u
  [../]
[]

[AuxVariables]
  [./error]
    family = MONOMIAL
    order = FIRST
  [../]
[]

[BCs]
  [./left]
    type = DirichletBC
    variable = u
    preset = false
    boundary = left
    value = 0
  [../]
  [./right]
    type = DirichletBC
    variable = u
    preset = false
    boundary = right
    value = 1
  [../]
[]

[Materials]
  [./call_me_mat]
    type = IncrementMaterial
    prop_names = 'diff'
    prop_values = '1'
    block = 0
    outputs = exodus
    output_properties = 'mat_prop'
  [../]
[]

[Executioner]
  type = Steady
# This test counts the number of residual evaluations that
# may slightly change from a PETSc version to another.
# For instance, starts from PETSc-3.8.4, the number of
# residual evaluating is reduced by one in a linear solver
# for each Newton iteration. This change causes this test
# fail. It  better to restrict the test
# count the residual evaluations in the nonlinear level only.
  solve_type = 'NEWTON'
  petsc_options_iname = '-pc_type -pc_factor_mat_solver_type'
  petsc_options_value = 'lu superlu_dist'
[]

[Outputs]
  exodus = true
[]

Child Objects

framework/include/auxkernels/ElementL2ErrorFunctionAux.h

framework/include/auxkernels/ElementL2ErrorFunctionAux.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

// MOOSE includes
#include "ElementLpNormAux.h"

// Forward declarations
class ElementL2ErrorFunctionAux;

template <>
InputParameters validParams<ElementL2ErrorFunctionAux>();

/**
 * A class for computing the element-wise L^2 error (actually L^p
 * error, if you set the value of p to something other than 2) of the
 * difference between an exact solution (typically represented by a
 * ParsedFunction) and the coupled solution variable.  The base
 * class implements the compute() function.
 */
class ElementL2ErrorFunctionAux : public ElementLpNormAux
{
public:
  static InputParameters validParams();

  /**
   * Class constructor
   * @param name Object name
   * @param parameters Object input parameters
   */
  ElementL2ErrorFunctionAux(const InputParameters & parameters);

protected:
  /**
   * Returns the difference between the solution variable and the
   * exact solution Function.
   */
  virtual Real computeValue() override;

  /// Function representing the exact solution.
  const Function & _func;
};

Input Parameters
Input Files
Child Objects

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools