FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net. Fast, secure and Free Open Source software downloads
Classes | Functions

Scalar_.H File Reference

Detailed Description

Definition in file Scalar_.H.

Go to the source code of this file.

Classes

class  pTraits< Scalar >

Functions

word  name (const Scalar)
 Return a string representation of a Scalar.
Scalar &  setComponent (Scalar &s, const direction)
Scalar  component (const Scalar s, const direction)
Scalar  sign (const Scalar s)
Scalar  pos (const Scalar s)
Scalar  neg (const Scalar s)
bool  equal (const Scalar &s1, const Scalar &s2)
bool  notEqual (const Scalar s1, const Scalar s2)
Scalar  limit (const Scalar s1, const Scalar s2)
Scalar  minMod (const Scalar s1, const Scalar s2)
Scalar  magSqr (const Scalar s)
Scalar  sqr (const Scalar s)
Scalar  sqrtSumSqr (const Scalar a, const Scalar b)
Scalar  pow3 (const Scalar s)
Scalar  pow4 (const Scalar s)
Scalar  pow5 (const Scalar s)
Scalar  pow6 (const Scalar s)
Scalar  inv (const Scalar s)
Scalar  dot (const Scalar s1, const Scalar s2)
Scalar  cmptMultiply (const Scalar s1, const Scalar s2)
Scalar  cmptDivide (const Scalar s1, const Scalar s2)
Scalar  cmptMax (const Scalar s)
Scalar  cmptMin (const Scalar s)
Scalar  cmptAv (const Scalar s)
Scalar  cmptMag (const Scalar s)
 transFunc (sqrt) transFunc(cbrt) transFunc(exp) transFunc(log) transFunc(log10) transFunc(sin) transFunc(cos) transFunc(tan) transFunc(asin) transFunc(acos) transFunc(atan) transFunc(sinh) transFunc(cosh) transFunc(tanh) transFunc(asinh) transFunc(acosh) transFunc(atanh) transFunc(erf) transFunc(erfc) transFunc(lgamma) transFunc(j0) transFunc(j1) transFunc(y0) transFunc(y1) inline Scalar stabilise(const Scalar s
Istream &  operator>> (Istream &, Scalar &)
Ostream &  operator<< (Ostream &, const Scalar)

Function Documentation

word name ( const   Scalar  )

Return a string representation of a Scalar.

Definition at line 49 of file Scalar_.C.

Referenced by KinematicCloud< ParcelType >::alpha(), ThermoCloud< ParcelType >::ap(), Cloud< ParticleType >::autoMap(), basicSourceList::basicSourceList(), DsmcCloud< ParcelType >::dumpParticlePositions(), ThermoCloud< ParcelType >::Ep(), Foam::findEtcFile(), Time::findInstance(), for(), forAll(), lduMatrix::smoother::getName(), lduMatrix::preconditioner::getName(), if(), KinematicCloud< ParcelType >::info(), DsmcCloud< ParcelType >::info(), LocalInteraction< CloudType >::LocalInteraction(), fvPatch::lookupPatchField(), UnsortedMeshedSurface< Face >::New(), MeshedSurface< Face >::New(), pointZone::New(), faceZone::New(), cellZone::New(), polyPatch::New(), lduMatrix::solver::New(), lduMatrix::smoother::New(), lduMatrix::preconditioner::New(), coordinateSystem::New(), radiativeIntensityRay::radiativeIntensityRay(), ReactingCloud< ParcelType >::ReactingCloud(), OBJsurfaceFormat< Face >::read(), NASsurfaceFormat< Face >::read(), FTRsurfaceFormat< Face >::read(), KinematicCloud< ParcelType >::rhoEff(), ODEChemistryModel< CompType, ThermoType >::RR(), ThermoCloud< ParcelType >::Sh(), ThermoCloud< ParcelType >::sigmap(), UnsortedMeshedSurface< Face >::sortedZones(), ReactingCloud< ParcelType >::Srho(), KinematicCloud< ParcelType >::SU(), dimensioned< tensor >::T(), KinematicCloud< ParcelType >::theta(), UnsortedMeshedSurface< Face >::write(), MeshedSurfaceProxy< Face >::write(), MeshedSurface< Face >::write(), ensightPart::writeHeader(), regIOobject::writeObject(), and Cloud< ParticleType >::writePositions().

Scalar& setComponent ( Scalar &   s,
const   direction  
) [inline]

Definition at line 99 of file Scalar_.H.

Scalar component ( const Scalar   s,
const   direction  
) [inline]

Definition at line 104 of file Scalar_.H.

Referenced by correlationFunction< Type >::calculateCorrelationFunction(), Field< Type >::component(), and FieldField< Field, Type >::component().

Scalar sign ( const Scalar   s  ) [inline]

Definition at line 109 of file Scalar_.H.

Referenced by octree< Type >::getVolType().

Scalar pos ( const Scalar   s  ) [inline]

Definition at line 114 of file Scalar_.H.

Referenced by Foam::bound(), if(), timeVaryingUniformTotalPressureFvPatchScalarField::updateCoeffs(), and timeVaryingMappedTotalPressureFvPatchScalarField::updateCoeffs().

Scalar neg ( const Scalar   s  ) [inline]

Definition at line 119 of file Scalar_.H.

bool equal ( const Scalar &   s1,
const Scalar &   s2  
) [inline]

Definition at line 124 of file Scalar_.H.

References Foam::mag(), and ScalarVSMALL.

Referenced by specieThermo< thermo >::Kc(), specieThermo< thermo >::Kn(), specieThermo< thermo >::Kx(), UList< T >::operator==(), FixedList< T, Size >::operator==(), and UILList< LListBase, T >::operator==().

bool notEqual ( const Scalar   s1,
const Scalar   s2  
) [inline]

Definition at line 129 of file Scalar_.H.

References Foam::mag(), and ScalarVSMALL.

Referenced by Foam::operator<<().

Scalar limit ( const Scalar   s1,
const Scalar   s2  
) [inline]

Definition at line 134 of file Scalar_.H.

References Foam::mag().

Scalar minMod ( const Scalar   s1,
const Scalar   s2  
) [inline]

Definition at line 139 of file Scalar_.H.

References Foam::mag().

Scalar magSqr ( const Scalar   s  ) [inline]

Definition at line 144 of file Scalar_.H.

Referenced by enrichedPatch::calcEnrichedFaces(), primitiveMesh::checkEdgeLength(), primitiveMesh::checkPointNearness(), LarsenBorgnakkeVariableHardSphere< CloudType >::collide(), tetrahedron< Point, PointRef >::containmentSphere(), linearUpwindV< Type >::correction(), treeLeaf< Type >::findNearest(), cellPointWeight::findTriangle(), tetrahedron< Point, PointRef >::gradNiSquared(), if(), Foam::kShellMean(), Foam::matchPoints(), Foam::mergePoints(), PrimitivePatch< Face, FaceList, PointField, PointType >::projectFaceCentres(), PrimitivePatch< Face, FaceList, PointField, PointType >::projectPoints(), timeVaryingUniformTotalPressureFvPatchScalarField::updateCoeffs(), and timeVaryingMappedTotalPressureFvPatchScalarField::updateCoeffs().

Scalar sqr ( const Scalar   s  ) [inline]

Definition at line 149 of file Scalar_.H.

Referenced by fieldAverage::addPrime2MeanField(), ReactingMultiphaseParcel< ParcelType >::calcDevolatilisation(), LiquidEvaporation< CloudType >::calculate(), COxidationMurphyShaddix< CloudType >::calculate(), COxidationKineticDiffusionLimitedRate< CloudType >::calculate(), primitiveMesh::checkEdgeLength(), FDICPreconditioner::FDICPreconditioner(), treeLeaf< Type >::findNearest(), geomDecomp::geomDecomp(), tetrahedron< Point, PointRef >::gradNiGradNi(), if(), FreeStream< CloudType >::inflow(), Foam::kShellIntegration(), Foam::matchPoints(), Foam::mergePoints(), pow3(), pow4(), pow6(), and sqrtSumSqr().

Scalar sqrtSumSqr ( const Scalar   a,
const Scalar   b  
) [inline]

Definition at line 154 of file Scalar_.H.

References Foam::mag(), Scalar, ScalarVSMALL, sqr(), and Foam::sqrt().

Referenced by SVD::SVD().

Scalar pow3 ( const Scalar   s  ) [inline]

Definition at line 169 of file Scalar_.H.

References sqr().

Referenced by ThermoParcel< ParcelType >::calcHeatTransfer(), ThermoCloud< ParcelType >::Ep(), FieldActivatedInjection< CloudType >::FieldActivatedInjection(), ManualInjection< CloudType >::ManualInjection(), pow6(), and InjectionModel< CloudType >::setNumberOfParticles().

Scalar pow4 ( const Scalar   s  ) [inline]

Definition at line 174 of file Scalar_.H.

References sqr().

Referenced by blackBodyEmission::blackBodyEmission(), ThermoParcel< ParcelType >::calcHeatTransfer(), ThermoCloud< ParcelType >::Ep(), greyDiffusiveRadiationMixedFvPatchScalarField::greyDiffusiveRadiationMixedFvPatchScalarField(), MarshakRadiationFixedTMixedFvPatchScalarField::MarshakRadiationFixedTMixedFvPatchScalarField(), MarshakRadiationFvPatchScalarField::MarshakRadiationFvPatchScalarField(), pow5(), and wideBandDiffusiveRadiationMixedFvPatchScalarField::wideBandDiffusiveRadiationMixedFvPatchScalarField().

Scalar pow5 ( const Scalar   s  ) [inline]

Definition at line 179 of file Scalar_.H.

References pow4().

Scalar pow6 ( const Scalar   s  ) [inline]

Definition at line 184 of file Scalar_.H.

References pow3(), and sqr().

Scalar inv ( const Scalar   s  ) [inline]

Definition at line 189 of file Scalar_.H.

Referenced by if().

Scalar dot ( const Scalar   s1,
const Scalar   s2  
) [inline]

Definition at line 194 of file Scalar_.H.

Scalar cmptMultiply ( const Scalar   s1,
const Scalar   s2  
) [inline]

Definition at line 199 of file Scalar_.H.

Referenced by faceAreaPairGAMGAgglomeration::faceAreaPairGAMGAgglomeration().

Scalar cmptDivide ( const Scalar   s1,
const Scalar   s2  
) [inline]

Definition at line 204 of file Scalar_.H.

Scalar cmptMax ( const Scalar   s  ) [inline]

Definition at line 209 of file Scalar_.H.

Referenced by FitData< FitDataType, ExtendedStencil, Polynomial >::calcFit().

Scalar cmptMin ( const Scalar   s  ) [inline]

Definition at line 214 of file Scalar_.H.

Scalar cmptAv ( const Scalar   s  ) [inline]

Definition at line 219 of file Scalar_.H.

Scalar cmptMag ( const Scalar   s  ) [inline]

Definition at line 224 of file Scalar_.H.

References Foam::mag().

Referenced by FitData< FitDataType, ExtendedStencil, Polynomial >::calcFit().

transFunc ( sqrt    ) const
Istream& operator>> ( Istream &   ,
Scalar &    
)

Referenced by CompactListList< T >::CompactListList(), CompactListList_dev< T, Container >::CompactListList_dev(), FixedList< T, Size >::FixedList(), LList< LListBase, T >::LList(), and StaticHashTable< T, Key, Hash >::StaticHashTable().

Ostream& operator<< ( Ostream &   ,
const   Scalar  
)