belfem::SourceFunction Class Reference

#include <cl_SourceFunction.hpp>

Public Member Functions
	SourceFunction ()
	~SourceFunction ()
	SourceFunction (const SourceFunction &)=delete
SourceFunction &	operator= (const SourceFunction &)=delete
	SourceFunction (SourceFunction &&)=delete
SourceFunction &	operator= (SourceFunction &&)=delete
SourceFunctionType	type () const
void	set_constant (const real aAmplitude)
void	set_ramp (const real aAmplitude, const real aPeriod, const real aTimeOffset=0.0)
void	set_sigmoid (const real aAmplitude, const real aPeriod, const real aTimeOffset, const real aFuzzyness=0.01)
void	set_periodic (const SourceFunctionType aType, const real aAmplitude, const real aPeriod, const real aPhase)
void	set_user_defined (UserFunc *Function)
void	read_user_defined (const string &aLibraryPath, const string &aLabel)
real	compute (const real aTime) const
real	amplitude () const
real	period () const
real	frequency () const
real	omega () const
real	phase () const
real	time_offset () const
real	fuzziness () const

Constructor & Destructor Documentation

SourceFunction() [1/3]

belfem::SourceFunction::SourceFunction

(

)

~SourceFunction()

belfem::SourceFunction::~SourceFunction

(

)

SourceFunction() [2/3]

belfem::SourceFunction::SourceFunction ( const SourceFunction & )

delete

SourceFunction() [3/3]

belfem::SourceFunction::SourceFunction ( SourceFunction && )

delete

Member Function Documentation

amplitude()

real belfem::SourceFunction::amplitude ( ) const

inline

compute()

real belfem::SourceFunction::compute ( const real aTime ) const

inline

frequency()

real belfem::SourceFunction::frequency ( ) const

inline

fuzziness()

real belfem::SourceFunction::fuzziness ( ) const

inline

omega()

real belfem::SourceFunction::omega ( ) const

inline

operator=() [1/2]

SourceFunction & belfem::SourceFunction::operator= ( const SourceFunction & )

delete

operator=() [2/2]

SourceFunction & belfem::SourceFunction::operator= ( SourceFunction && )

delete

period()

real belfem::SourceFunction::period ( ) const

inline

phase()

real belfem::SourceFunction::phase ( ) const

inline

read_user_defined()

void belfem::SourceFunction::read_user_defined	(	const string &	aLibraryPath,
		const string &	aLabel )

set_constant()

void belfem::SourceFunction::set_constant

(

const real

aAmplitude

)

set_periodic()

void belfem::SourceFunction::set_periodic	(	const SourceFunctionType	aType,
		const real	aAmplitude,
		const real	aPeriod,
		const real	aPhase )

set_ramp()

void belfem::SourceFunction::set_ramp	(	const real	aAmplitude,
		const real	aPeriod,
		const real	aTimeOffset = 0.0 )

set_sigmoid()

void belfem::SourceFunction::set_sigmoid	(	const real	aAmplitude,
		const real	aPeriod,
		const real	aTimeOffset,
		const real	aFuzzyness = 0.01 )

set_user_defined()

void belfem::SourceFunction::set_user_defined

(

UserFunc *

Function

)

time_offset()

real belfem::SourceFunction::time_offset ( ) const

inline

type()

SourceFunctionType belfem::SourceFunction::type ( ) const

inline

---

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

• src/numerics/sources/cl_SourceFunction.hpp
• src/numerics/sources/cl_SourceFunction.cpp