QUESO::LibMeshFunction Class Reference

Function objects using libMesh for the backend. More...

#include <LibMeshFunction.h>

Inheritance diagram for QUESO::LibMeshFunction:

Public Member Functions
void	print_info () const
	Will print mesh-related libMesh foo to std::cerr. More...
virtual void	save_function (const std::string &filename, double time) const
	Save the current function to an Exodus file called filename. time is the time to attach to the function and is usually the iteration number. More...
virtual void	add (double scale, const FunctionBase &rhs)
	Execute this += scale * rhs. More...
virtual void	pointwise_mult (const FunctionBase &f1, const FunctionBase &f2)
	Pointwise multiply f1 and f2 and store the result in *this. More...
virtual void	scale (double scale)
	Execute this *= scale. More...
virtual void	zero ()
	Set this to zero everywhere. More...
virtual double	L2_norm () const
	Return the L2-norm of this. More...
virtual SharedPtr < FunctionBase >::Type	zero_clone () const
	Create a zero function copy of this and return pointer to it. More...
virtual SharedPtr < libMesh::EquationSystems > ::Type	get_equation_systems () const
	Return the internal libmesh equation systems object. More...
Constructor/Destructor methods
	LibMeshFunction (const FunctionOperatorBuilder &builder, libMesh::MeshBase &m)
	Construct a function with a user-provided mesh m and builder. More...
	~LibMeshFunction ()
	Destructor. More...
Public Member Functions inherited from QUESO::FunctionBase
	FunctionBase ()
	Constructor. More...
virtual	~FunctionBase ()
	Destructor. More...

Private Attributes
const FunctionOperatorBuilder &	builder
SharedPtr < libMesh::EquationSystems > ::Type	equation_systems

Detailed Description

Function objects using libMesh for the backend.

Definition at line 53 of file LibMeshFunction.h.

Constructor & Destructor Documentation

QUESO::LibMeshFunction::LibMeshFunction	(	const FunctionOperatorBuilder &	builder,
		libMesh::MeshBase &	m
	)

Construct a function with a user-provided mesh m and builder.

It is expected the lifetime of m will outlive this

A builder object is just one that a FEM library backend can use to set up various options. Polynomial type, polynomial order, and the number of eigenpairs to request are good examples.

Definition at line 64 of file LibMeshFunction.C.

References equation_systems, and QUESO::FunctionOperatorBuilder::order.

Referenced by zero_clone().

  : FunctionBase(),
    builder(builder),
    equation_systems(new libMesh::EquationSystems(m))
{
  this->equation_systems->add_system<libMesh::ExplicitSystem>("Function");
  this->equation_systems->get_system("Function").add_variable("u",
      libMesh::Utility::string_to_enum<libMeshEnums::Order>(this->builder.order),
      libMesh::Utility::string_to_enum<libMeshEnums::FEFamily>(this->builder.family));
  this->equation_systems->init();
}

QUESO::LibMeshFunction::~LibMeshFunction

(

)

Destructor.

Definition at line 77 of file LibMeshFunction.C.

{
}

Member Function Documentation

void QUESO::LibMeshFunction::add ( double  scale, const FunctionBase &  rhs  )

virtual

Execute this += scale * rhs.

Implements QUESO::FunctionBase.

Definition at line 96 of file LibMeshFunction.C.

References equation_systems.

                                                                {
  // We know we're dealing with a derived class type, so cast
  const LibMeshFunction & rhs_derived = dynamic_cast<
    const LibMeshFunction &>(rhs);

  this->equation_systems->get_system<libMesh::ExplicitSystem>("Function").solution->add(
      scale, *(rhs_derived.equation_systems->get_system<libMesh::ExplicitSystem>(
          "Function").solution));
}

SharedPtr< libMesh::EquationSystems >::Type QUESO::LibMeshFunction::get_equation_systems ( ) const

virtual

Return the internal libmesh equation systems object.

Definition at line 150 of file LibMeshFunction.C.

References equation_systems.

Referenced by QUESO::LibMeshOperatorBase::inverse_kl_transform().

                                            {
  return this->equation_systems;
}

double QUESO::LibMeshFunction::L2_norm ( ) const

virtual

Return the L2-norm of this.

Implements QUESO::FunctionBase.

Definition at line 129 of file LibMeshFunction.C.

References equation_systems.

                                      {
  libMesh::ExplicitSystem & system =
    this->equation_systems->get_system<libMesh::ExplicitSystem>("Function");

  double norm = system.calculate_norm(*system.solution,
                                      libMesh::SystemNorm(libMeshEnums::L2));
  return norm;
}

void QUESO::LibMeshFunction::pointwise_mult ( const FunctionBase &  f1, const FunctionBase &  f2  )

virtual

Pointwise multiply f1 and f2 and store the result in *this.

Implements QUESO::FunctionBase.

Definition at line 106 of file LibMeshFunction.C.

References equation_systems.

{
  const LibMeshFunction & f1_derived = static_cast<
    const LibMeshFunction &>(f1);
  const LibMeshFunction & f2_derived = static_cast<
    const LibMeshFunction &>(f2);

  this->equation_systems->get_system<libMesh::ExplicitSystem>("Function").solution->pointwise_mult(
      *(f1_derived.equation_systems->get_system<libMesh::ExplicitSystem>("Function").solution),
      *(f2_derived.equation_systems->get_system<libMesh::ExplicitSystem>("Function").solution));
}

void QUESO::LibMeshFunction::print_info

(

)

const

Will print mesh-related libMesh foo to std::cerr.

Definition at line 81 of file LibMeshFunction.C.

References equation_systems.

{
  // Print information about the mesh to the screen.
  this->equation_systems->get_mesh().print_info(std::cerr);
}

void QUESO::LibMeshFunction::save_function ( const std::string &  filename, double  time  ) const

virtual

Save the current function to an Exodus file called filename. time is the time to attach to the function and is usually the iteration number.

Implements QUESO::FunctionBase.

Definition at line 87 of file LibMeshFunction.C.

References equation_systems.

{
  // The "1" is hardcoded for the number of time steps because the ExodusII
  // manual states that it should be the number of timesteps within the file.
  // Here, we are explicitly only doing one timestep per file.
  libMesh::ExodusII_IO(this->equation_systems->get_mesh()).write_timestep(
      filename, *this->equation_systems, 1, time);
}

void QUESO::LibMeshFunction::scale ( double  scale )

virtual

Execute this *= scale.

Implements QUESO::FunctionBase.

Definition at line 119 of file LibMeshFunction.C.

References equation_systems.

                                        {
  this->equation_systems->get_system<libMesh::ExplicitSystem>(
      "Function").solution->scale(scale);
}

void QUESO::LibMeshFunction::zero ( )

virtual

Set this to zero everywhere.

Implements QUESO::FunctionBase.

Definition at line 124 of file LibMeshFunction.C.

References equation_systems.

                           {
  this->equation_systems->get_system<libMesh::ExplicitSystem>(
      "Function").solution->zero();
}

SharedPtr< FunctionBase >::Type QUESO::LibMeshFunction::zero_clone ( ) const

virtual

Create a zero function copy of this and return pointer to it.

Create a new instance of FunctionBase representing the function that is identically zero (by copying this) everywhere and return a boost shared pointer to it

Implements QUESO::FunctionBase.

Definition at line 138 of file LibMeshFunction.C.

References builder, equation_systems, and LibMeshFunction().

{
  LibMeshFunction * clone = new LibMeshFunction(this->builder,
      this->equation_systems->get_mesh());
  clone->equation_systems->get_system<libMesh::ExplicitSystem>(
      "Function").solution->zero();

  SharedPtr<FunctionBase>::Type ptr(clone);
  return ptr;
}

Member Data Documentation

const FunctionOperatorBuilder& QUESO::LibMeshFunction::builder

private

Definition at line 107 of file LibMeshFunction.h.

Referenced by zero_clone().

SharedPtr<libMesh::EquationSystems>::Type QUESO::LibMeshFunction::equation_systems

private

Definition at line 109 of file LibMeshFunction.h.

Referenced by add(), get_equation_systems(), L2_norm(), LibMeshFunction(), pointwise_mult(), print_info(), save_function(), scale(), zero(), and zero_clone().

---

The documentation for this class was generated from the following files:

• src/core/inc/LibMeshFunction.h
• src/core/src/LibMeshFunction.C