MassOperator Class Reference

#include <MassOperator.hpp>

Inheritance diagram for MassOperator:

[legend]

Collaboration diagram for MassOperator:

[legend]

List of all members.

Public Types
enum	Type {   firstorderop, firstorderopTransposed, divmugrad, secondorderop,   massop }
Public Member Functions
std::string	typeName () const
ConstReferenceCounting < ScalarFunctionBase >	alpha () const
ConstReferenceCounting < PDEOperator >	operator* (const ConstReferenceCounting< ScalarFunctionBase > &c) const
ConstReferenceCounting < PDEOperator >	operator- () const
	MassOperator (ConstReferenceCounting< ScalarFunctionBase > alpha)
	MassOperator (const MassOperator &M)
	~MassOperator ()
const size_t &	numberOfSubOperators () const
const PDEOperator::Type &	type () const
Protected Attributes
const PDEOperator::Type	__type
size_t	__numberOfSubOperators
Private Attributes
ConstReferenceCounting < ScalarFunctionBase >	__Alpha
Friends
std::ostream &	operator<< (std::ostream &os, const PDEOperator &pdeOperator)

---

Detailed Description

Definition at line 34 of file MassOperator.hpp.

---

Member Enumeration Documentation

enum PDEOperator::Type [inherited]

Enumerator:

firstorderop
firstorderopTransposed
divmugrad
secondorderop
massop

Definition at line 41 of file PDEOperator.hpp.

            {
    firstorderop,
    firstorderopTransposed,
    divmugrad,
    secondorderop,
    massop
  };

---

Constructor & Destructor Documentation

MassOperator::MassOperator

(

ConstReferenceCounting< ScalarFunctionBase >

alpha

)

[inline]

Constructor

Parameters:

alpha

given coefficient

Definition at line 98 of file MassOperator.hpp.

Referenced by operator*(), and operator-().

    : PDEOperator(PDEOperator::massop,
                  1),
      __Alpha(alpha)
  {
    ;
  }

MassOperator::MassOperator

(

const MassOperator &

M

)

[inline]

Copy constructor

Parameters:

M

given mass operator

Definition at line 111 of file MassOperator.hpp.

    : PDEOperator(M),
      __Alpha(M.__Alpha)
  {
    ;
  }

MassOperator::~MassOperator

(

)

[inline]

Destructor

Definition at line 122 of file MassOperator.hpp.

  {
    ;
  }

---

Member Function Documentation

std::string MassOperator::typeName

(

)

const [inline, virtual]

gets operator name

Returns:

"MassOperator"

Implements PDEOperator.

Definition at line 47 of file MassOperator.hpp.

  {
    return "MassOperator";
  }

ConstReferenceCounting<ScalarFunctionBase> MassOperator::alpha

(

)

const [inline]

Read only access to the coefficient

Returns:

.

Definition at line 58 of file MassOperator.hpp.

References __Alpha.

Referenced by DiscretizedOperators< FiniteElement::ElementaryMatrix >::DiscretizedOperators().

  {
    return __Alpha;
  }

ConstReferenceCounting<PDEOperator> MassOperator::operator*

(

const ConstReferenceCounting< ScalarFunctionBase > &

c

)

const [inline, virtual]

"multiplies" the mass MassOperator by a coefficient

Parameters:

c

the coefficient

Returns:

Implements PDEOperator.

Definition at line 71 of file MassOperator.hpp.

References __Alpha, ScalarFunctionBuilder::getBuiltFunction(), MassOperator(), BinaryOperation::product, ScalarFunctionBuilder::setBinaryOperation(), and ScalarFunctionBuilder::setFunction().

  {
    ScalarFunctionBuilder functionBuilder;
    functionBuilder.setFunction(__Alpha);
    functionBuilder.setBinaryOperation(BinaryOperation::product,c);
    return new MassOperator(functionBuilder.getBuiltFunction());
  }

Here is the call graph for this function:

ConstReferenceCounting<PDEOperator> MassOperator::operator-

(

)

const [inline, virtual]

gets the opposed MassOperator operator.

Returns:

Implements PDEOperator.

Definition at line 85 of file MassOperator.hpp.

References __Alpha, ScalarFunctionBuilder::getBuiltFunction(), MassOperator(), ScalarFunctionBuilder::setFunction(), and ScalarFunctionBuilder::setUnaryMinus().

  {
    ScalarFunctionBuilder functionBuilder;
    functionBuilder.setFunction(__Alpha);
    functionBuilder.setUnaryMinus();
    return new MassOperator(functionBuilder.getBuiltFunction());
  }

Here is the call graph for this function:

const size_t& PDEOperator::numberOfSubOperators

(

)

const [inline, inherited]

Read only access to the number of sub-operators

Returns:

__numberOfSubOperators

Definition at line 63 of file PDEOperator.hpp.

References PDEOperator::__numberOfSubOperators.

  {
    return __numberOfSubOperators;
  }

const PDEOperator::Type& PDEOperator::type

(

)

const [inline, inherited]

Read-only access to the type of the operator

Returns:

__type

Definition at line 82 of file PDEOperator.hpp.

References PDEOperator::__type.

Referenced by DiscretizedOperators< FiniteElement::ElementaryMatrix >::DiscretizedOperators().

  {
    return __type;
  }

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const PDEOperator &	pdeOperator
	)			[friend, inherited]

Writes a PDEOperator to a stream

Parameters:

	os	the output stream
	pdeOperator	a PDEOperator

Returns:

os

Definition at line 114 of file PDEOperator.hpp.

  {
    os << pdeOperator.typeName();
    return os;
  }

---

Member Data Documentation

ConstReferenceCounting<ScalarFunctionBase> MassOperator::__Alpha [private]

order 0 coefficient

Definition at line 39 of file MassOperator.hpp.

Referenced by alpha(), operator*(), and operator-().

const PDEOperator::Type PDEOperator::__type [protected, inherited]

type of the operator

Definition at line 50 of file PDEOperator.hpp.

Referenced by PDEOperator::type().

size_t PDEOperator::__numberOfSubOperators [protected, inherited]

This is used for "composed" operators to provied an efficient way to know how many elementary matrices are needed to discretize it

Definition at line 52 of file PDEOperator.hpp.

Referenced by PDEOperator::numberOfSubOperators().

---

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

• MassOperator.hpp