SolVecSAFunc Class Reference

Detailed Description

A SAFunc which gets its values from a distributed vector of values on degrees of freedom.

Definition at line 38 of file SolVecSAFunc.hpp.

#include <SolVecSAFunc.hpp>

Inheritance diagram for SolVecSAFunc:

Public Member Functions
	SolVecSAFunc (DHVecPtr *sol, CepsFunctionFlag loc)
	Default constructor. Vector is passed as pointer on pointer in order to pass a U^n, which adress can change (e.g. in multistep methods) More...
	SolVecSAFunc (const SolVecSAFunc &)=default
	We allow the copy from a functor to another. More...
SolVecSAFunc &	operator= (const SolVecSAFunc &)=default
	We allow the assignement from a functor to another. More...
void	setDataPointer (DHVecPtr *sol)
	Sets the link to data. More...
CepsEnum	getFlags () const final
	Return the vector dependance flag + location, does not mean that the content of the vector can not change. More...
virtual void	getLocalData () final
	Authorize access to data for solvecSAFunc, other derived classes : nothing. More...
virtual void	releaseLocalData () final
	Authorize access to data for solvecSAFunc, other derived classes : nothing. More...
Public Member Functions inherited from SAFunc< CepsReal >
	SAFunc (const SAFunc &)=default
	We allow the copy from a functor to another. More...
SAFunc &	operator= (const SAFunc &)=default
	We allow the assignement from a functor to another. More...
CepsBool	hasOption (CepsFunctionFlag flag)
	Tells if option is activated. More...

Protected Member Functions
void	checkLocation (const CepsFunctionFlag &loc)
	Determines if flag passed in constructor is valid (cells or nodes ID) More...
void	setArgsFromLocation (CepsStandardArgs &args) const
	Sets args.u from the location flag. More...

Protected Attributes
DHVecPtr *	m_sol
	Pointed data. More...
CepsFunctionFlag	m_location
	To get the correct index in the vector. More...

Additional Inherited Members
Public Types inherited from SAFunc< CepsReal >
using	BaseFunction = ceps::Function< CepsReal(CepsStandardArgs)>
	Typedef for the function type. More...

Constructor & Destructor Documentation

SolVecSAFunc() [1/2]

SolVecSAFunc::SolVecSAFunc	(	DHVecPtr *	sol,
		CepsFunctionFlag	loc
	)

Default constructor. Vector is passed as pointer on pointer in order to pass a U^n, which adress can change (e.g. in multistep methods)

Definition at line 35 of file SolVecSAFunc.cpp.

SolVecSAFunc() [2/2]

SolVecSAFunc::SolVecSAFunc ( const SolVecSAFunc &  )

default

We allow the copy from a functor to another.

Member Function Documentation

checkLocation()

void SolVecSAFunc::checkLocation ( const CepsFunctionFlag &  loc )

protected

Determines if flag passed in constructor is valid (cells or nodes ID)

Definition at line 76 of file SolVecSAFunc.cpp.

getFlags()

CepsEnum SolVecSAFunc::getFlags ( ) const

finalvirtual

Return the vector dependance flag + location, does not mean that the content of the vector can not change.

Implements SAFunc< CepsReal >.

Definition at line 52 of file SolVecSAFunc.cpp.

getLocalData()

void SolVecSAFunc::getLocalData ( )

finalvirtual

Authorize access to data for solvecSAFunc, other derived classes : nothing.

Reimplemented from SAFunc< CepsReal >.

Definition at line 64 of file SolVecSAFunc.cpp.

operator=()

SolVecSAFunc& SolVecSAFunc::operator= ( const SolVecSAFunc &  )

default

We allow the assignement from a functor to another.

releaseLocalData()

void SolVecSAFunc::releaseLocalData ( )

finalvirtual

Authorize access to data for solvecSAFunc, other derived classes : nothing.

Reimplemented from SAFunc< CepsReal >.

Definition at line 70 of file SolVecSAFunc.cpp.

setArgsFromLocation()

void SolVecSAFunc::setArgsFromLocation ( CepsStandardArgs &  args ) const

protected

Sets args.u from the location flag.

Definition at line 87 of file SolVecSAFunc.cpp.

setDataPointer()

void SolVecSAFunc::setDataPointer

(

DHVecPtr *

sol

)

Sets the link to data.

Definition at line 43 of file SolVecSAFunc.cpp.

Field Documentation

m_location

CepsFunctionFlag SolVecSAFunc::m_location

protected

To get the correct index in the vector.

Definition at line 83 of file SolVecSAFunc.hpp.

m_sol

DHVecPtr* SolVecSAFunc::m_sol

protected

Pointed data.

Definition at line 80 of file SolVecSAFunc.hpp.

---

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

• /builds/xxjFYZX3/0/carmen/ceps/src/pde/common/functions/SolVecSAFunc.hpp
• /builds/xxjFYZX3/0/carmen/ceps/src/pde/common/functions/SolVecSAFunc.cpp