This experiment records the complex impedance of the experimental cell in galvanostatic mode, starting from the start frequency and sweeping through towards the end frequency, with a fixed number of frequency steps per decade. More...

#include <AisEISGalvanostaticElement.h>

Inherits AisAbstractElement.

Public Member Functions
	AisEISGalvanostaticElement (double startFrequency, double endFrequency, double stepsPerDecade, double currentBias, double currentAmplitude)
	the EIS galvanostatic element constructor. More...

	AisEISGalvanostaticElement (const AisEISGalvanostaticElement &)
	copy constructor for the AisEISGalvanostaticElement object.

AisEISGalvanostaticElement &	operator= (const AisEISGalvanostaticElement &)
	overload equal to operator for the AisEISGalvanostaticElement object.

QString	getName () const override
	get the name of the element. More...

QStringList	getCategory () const override
	get a list of applicable categories of the element. More...

double	getQuietTime () const
	Gets the quiet time duration. More...

void	setQuietTime (double quietTime)
	Sets the quiet time duration. More...

double	getQuietTimeSamplingInterval () const
	gets the quiet time sampling interval. More...

void	setQuietTimeSamplingInterval (double quietTimeSamplingInterval)
	Sets the quiet time sampling interval. More...

double	getStartFreq () const
	get the value set for the current starting frequency More...

void	setStartFreq (double startFreq)
	set the value for the current starting frequency. More...

double	getEndFreq () const
	the value set for the current ending frequency. More...

void	setEndFreq (double endFreq)
	set the value for the current end frequency. More...

double	getStepsPerDecade () const
	get the value set for the current frequency steps per decade. More...

void	setStepsPerDecade (double stepsPerDecade)
	set the number of the current frequency steps per decade. More...

double	getBiasCurrent () const
	get the value set for the DC bias (DC offset). More...

void	setBiasCurrent (double biasCurrent)
	set the value for the DC bias (DC offset). More...

double	getAmplitude () const
	the value to set for the AC current amplitude. More...

void	setAmplitude (double amplitude)
	set the value for the AC current amplitude. More...

unsigned int	getMinimumCycles () const
	get the minimum number of periods of applied sinusoidal current to sample at each frequency. More...

void	setMinimumCycles (unsigned int numberOfCycle)
	set the minimum number of periods of applied sinusoidal current to sample at each frequency. More...

Detailed Description

This experiment records the complex impedance of the experimental cell in galvanostatic mode, starting from the start frequency and sweeping through towards the end frequency, with a fixed number of frequency steps per decade.

Important parameters include the DC bias and the AC excitation amplitude.

Constructor & Destructor Documentation

◆ AisEISGalvanostaticElement()

AisEISGalvanostaticElement::AisEISGalvanostaticElement	(	double	startFrequency,
		double	endFrequency,
		double	stepsPerDecade,
		double	currentBias,
		double	currentAmplitude
	)

explicit

the EIS galvanostatic element constructor.

Parameters

startFrequency	the value for the current starting frequency
endFrequency	the value for the current ending frequency
stepsPerDecade	the value for the current frequency steps per decade.
currentBias	the value for the DC bias (DC offset).
currentAmplitude	the AC current amplitude.

Member Function Documentation

◆ getAmplitude()

double AisEISGalvanostaticElement::getAmplitude ( ) const

the value to set for the AC current amplitude.

Returns: the value set for the AC current amplitude in Amps.

◆ getBiasCurrent()

double AisEISGalvanostaticElement::getBiasCurrent ( ) const

get the value set for the DC bias (DC offset).

Returns: the value set for the DC bias in Amps.

◆ getCategory()

QStringList AisEISGalvanostaticElement::getCategory ( ) const

override

get a list of applicable categories of the element.

Returns: A list of applicable categories: ("Galvanostatic Control", "Impedance Methods", "Basic Experiments").

◆ getEndFreq()

double AisEISGalvanostaticElement::getEndFreq ( ) const

the value set for the current ending frequency.

Returns: the value set for the current end frequency in Hz

◆ getMinimumCycles()

unsigned int AisEISGalvanostaticElement::getMinimumCycles ( ) const

get the minimum number of periods of applied sinusoidal current to sample at each frequency.

Returns: get number of cycles to sample at each frequency.

◆ getName()

QString AisEISGalvanostaticElement::getName ( ) const

override

get the name of the element.

Returns: The name of the element: "Galvanostatic EIS".

◆ getQuietTime()

double AisEISGalvanostaticElement::getQuietTime ( ) const

Gets the quiet time duration.

Returns: The quiet time duration in seconds.

◆ getQuietTimeSamplingInterval()

double AisEISGalvanostaticElement::getQuietTimeSamplingInterval ( ) const

gets the quiet time sampling interval.

Returns: samplingInterval The quiet time sampling interval to set in seconds.

◆ getStartFreq()

double AisEISGalvanostaticElement::getStartFreq ( ) const

get the value set for the current starting frequency

Returns: the value set for the current start frequency in Hz?

◆ getStepsPerDecade()

double AisEISGalvanostaticElement::getStepsPerDecade ( ) const

get the value set for the current frequency steps per decade.

Returns: the value set for the current frequency steps per decade. This is unit-less.

◆ setAmplitude()

void AisEISGalvanostaticElement::setAmplitude ( double amplitude )

set the value for the AC current amplitude.

Parameters

amplitude the value to set for the AC current amplitude in Amps.

◆ setBiasCurrent()

void AisEISGalvanostaticElement::setBiasCurrent ( double biasCurrent )

set the value for the DC bias (DC offset).

Parameters

biasCurrent the value to set for the DC bias in Amps.

◆ setEndFreq()

void AisEISGalvanostaticElement::setEndFreq ( double endFreq )

set the value for the current end frequency.

Parameters

endFreq the value to set for the current end frequency in Hz

◆ setMinimumCycles()

void AisEISGalvanostaticElement::setMinimumCycles ( unsigned int numberOfCycle )

set the minimum number of periods of applied sinusoidal current to sample at each frequency.

Parameters

numberOfCycle number of cycles to sample at each frequency.

◆ setQuietTime()

void AisEISGalvanostaticElement::setQuietTime ( double quietTime )

Sets the quiet time duration.

Parameters

quietTime The quiet time duration to set in seconds.

◆ setQuietTimeSamplingInterval()

void AisEISGalvanostaticElement::setQuietTimeSamplingInterval ( double quietTimeSamplingInterval )

Sets the quiet time sampling interval.

Parameters

quietTimeSamplingInterval The quiet time sampling interval to set in seconds.

◆ setStartFreq()

void AisEISGalvanostaticElement::setStartFreq ( double startFreq )

set the value for the current starting frequency.

Parameters

startFreq the value to set the current starting frequency in Hz

◆ setStepsPerDecade()

void AisEISGalvanostaticElement::setStepsPerDecade ( double stepsPerDecade )

set the number of the current frequency steps per decade.

Parameters

stepsPerDecade the value to set for the number of steps per decade.

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

AisEISGalvanostaticElement.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AisEISGalvanostaticElement()

Member Function Documentation

◆ getAmplitude()

◆ getBiasCurrent()

◆ getCategory()

◆ getEndFreq()

◆ getMinimumCycles()

◆ getName()

◆ getQuietTime()

◆ getQuietTimeSamplingInterval()

◆ getStartFreq()

◆ getStepsPerDecade()

◆ setAmplitude()

◆ setBiasCurrent()

◆ setEndFreq()

◆ setMinimumCycles()

◆ setQuietTime()

◆ setQuietTimeSamplingInterval()

◆ setStartFreq()

◆ setStepsPerDecade()