SOFUS ..
Public Member Functions | List of all members
CircularAperture< T > Class Template Reference

#include <circular.hpp>

Public Member Functions

 CircularAperture ()
 
 CircularAperture (T radius)
 
 ~CircularAperture ()
 
const size_t & NMaxDivAGet () const
 
const T & DensityGet () const
 
void DensitySet (const T &rho)
 
void RadiusSet (const T &radius)
 
const T & RadiusGet () const
 
void DelaySet (const T &delay)
 
const T & DelayGet () const
 
int NMaxDivASet (const size_t &nDivW)
 
const T & F0Get () const
 
void F0Set (const T &f0)
 
void FsSet (const T &fs)
 
const T & FsGet () const
 
void CSet (const T &fs)
 
const T & CGet () const
 
const T & WGet () const
 
void WSet (const T &w)
 
const T & GridSectorScaleGet () const
 
void GridSectorScaleSet (const T &gss)
 
int CalcCwFieldRef (const T *pos, const size_t nPositions, const size_t nDim, std::complex< T > **odata, size_t *nOutPositions)
 
CalcTransientFieldRef (const T *pos, const size_t nPositions, const size_t nDim, T **odata, size_t *nSignals, size_t *nSamples)
 

Constructor & Destructor Documentation

◆ CircularAperture() [1/2]

◆ CircularAperture() [2/2]

CircularAperture ( radius)

◆ ~CircularAperture()

Member Function Documentation

◆ CalcCwFieldRef()

int CalcCwFieldRef ( const T *  pos,
const size_t  nPositions,
const size_t  nDim,
std::complex< T > **  odata,
size_t *  nOutPositions 
)

$
p(r,z;\omega) = v(w) rho_0 * a * c / pi * int
$

$
H(r,z;k) = a / (ik\pi) int
$

$
p(r,z,k) = -i v(\omega) * \rho_0 \omega H
$

Parameters
pos
nPositions
nDim
odata
nOutPositions

◆ CalcTransientFieldRef()

T CalcTransientFieldRef ( const T *  pos,
const size_t  nPositions,
const size_t  nDim,
T **  odata,
size_t *  nSignals,
size_t *  nSamples 
)

Compute transient field at the specified positions. The pulse is a simple tone-burst specified by setting the length w and center frequency f0.

auto a = CircularAperture<float>(radius); a.F0Set(1e6); a.WSet(nCycles / 1e6)

a.CalcTransientFieldRef(pPositions, nPositions, 3, ppOutData, pNSignals, pNSamples)

Parameters
pos
nPositions
nDim
odata
nSignals
nSamples
Returns

◆ CGet()

const T & CGet ( ) const

◆ CSet()

void CSet ( const T &  fs)

◆ DelayGet()

const T & DelayGet ( ) const

◆ DelaySet()

void DelaySet ( const T &  delay)

◆ DensityGet()

const T & DensityGet ( ) const

◆ DensitySet()

void DensitySet ( const T &  rho)

◆ F0Get()

const T & F0Get ( ) const

Get center frequency

Returns

◆ F0Set()

void F0Set ( const T &  f0)

Set center frequency

Parameters
f0

◆ FsGet()

const T & FsGet ( ) const

◆ FsSet()

void FsSet ( const T &  fs)

◆ GridSectorScaleGet()

const T & GridSectorScaleGet ( ) const

◆ GridSectorScaleSet()

void GridSectorScaleSet ( const T &  gss)

Set center frequency

Parameters
gss

◆ NMaxDivAGet()

const size_t & NMaxDivAGet ( ) const

Get max number of angular abcissas

Returns
# of abcissa in the width dimension

◆ NMaxDivASet()

int NMaxDivASet ( const size_t &  nDivW)

Set max number of angular abcissas

Parameters
nDivW

◆ RadiusGet()

const T & RadiusGet ( ) const

◆ RadiusSet()

void RadiusSet ( const T &  radius)

◆ WGet()

const T & WGet ( ) const

Get width of pulse [s]

Returns

◆ WSet()

void WSet ( const T &  w)

Set width of pulse [s]. TODO: Figure this out

Parameters
w

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