Loading...
Searching...
No Matches
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
Foam::functionObjects::ITHACAforces Class Reference

#include <ITHACAforces.H>

Inheritance diagram for Foam::functionObjects::ITHACAforces:

Public Member Functions

 TypeName ("ITHACAforces")
 
 ITHACAforces (const word &name, const Time &runTime, const dictionary &dict)
 
 ITHACAforces (const word &name, const objectRegistry &obr, const dictionary &)
 
virtual ~ITHACAforces ()
 
virtual bool read (const dictionary &)
 
virtual void calcForcesMoment ()
 
virtual vector forceEff () const
 
virtual vector momentEff () const
 
virtual vector forceTau () const
 
virtual vector forcePressure () const
 
virtual vector forcePorous () const
 
virtual bool execute ()
 
virtual bool write ()
 
 TypeName ("ITHACAforces")
 
 ITHACAforces (const word &name, const Time &runTime, const dictionary &dict, const bool readFields=true)
 
 ITHACAforces (const word &name, const objectRegistry &obr, const dictionary &dict, const bool readFields=true)
 
virtual ~ITHACAforces ()
 
virtual bool read (const dictionary &)
 
virtual void calcForcesMoment ()
 
virtual vector forceEff () const
 
virtual vector momentEff () const
 
virtual vector forceTau () const
 
virtual vector forcePressure () const
 
virtual bool execute ()
 
virtual bool write ()
 

Protected Types

enum  fileID { MAIN_FILE = 0 , BINS_FILE = 1 }
 

Protected Member Functions

wordList createFileNames (const dictionary &dict) const
 
virtual void writeFileHeader (const label i)
 
void initialise ()
 
tmp< volSymmTensorField > devRhoReff () const
 
tmp< volScalarField > mu () const
 
tmp< volScalarField > rho () const
 
scalar rho (const volScalarField &p) const
 
void applyBins (const vectorField &Md, const vectorField &fN, const vectorField &fT, const vectorField &fP, const vectorField &d)
 
void writeForces ()
 
void writeBins ()
 
 ITHACAforces (const ITHACAforces &)
 
void operator= (const ITHACAforces &)
 
word fieldName (const word &name) const
 
void createFiles ()
 
void writeIntegratedHeader (const word &header, Ostream &os) const
 
void writeBinHeader (const word &header, Ostream &os) const
 
void initialise ()
 
void initialiseBins ()
 
void resetFields ()
 
tmp< volSymmTensorField > devRhoReff () const
 
tmp< volScalarField > mu () const
 
tmp< volScalarField > rho () const
 
scalar rho (const volScalarField &p) const
 
void applyBins (const vectorField &Md, const vectorField &fN, const vectorField &fT, const vectorField &fP, const vectorField &d)
 
void addToFields (const label patchi, const vectorField &Md, const vectorField &fN, const vectorField &fT, const vectorField &fP)
 
void addToFields (const labelList &cellIDs, const vectorField &Md, const vectorField &fN, const vectorField &fT, const vectorField &fP)
 
void writeIntegratedForceMoment (const string &descriptor, const vectorField &fm0, const vectorField &fm1, const vectorField &fm2, autoPtr< OFstream > &osPtr) const
 
void writeForces ()
 
void writeBinnedForceMoment (const List< Field< vector > > &fm, autoPtr< OFstream > &osPtr) const
 
void writeBins ()
 
 ITHACAforces (const ITHACAforces &)=delete
 
void operator= (const ITHACAforces &)=delete
 

Protected Attributes

List< Field< vector > > force_
 
List< Field< vector > > moment_
 
labelHashSet patchSet_
 
word pName_
 
word UName_
 
word rhoName_
 
Switch directForceDensity_
 
word fDName_
 
scalar rhoRef_
 
scalar pRef_
 
coordinateSystem coordSys_
 
bool localSystem_
 
bool porosity_
 
label nBin_
 
vector binDir_
 
scalar binDx_
 
scalar binMin_
 
List< point > binPoints_
 
bool binCumulative_
 
bool initialised_
 
autoPtr< OFstream > forceFilePtr_
 
autoPtr< OFstream > momentFilePtr_
 
autoPtr< OFstream > forceBinFilePtr_
 
autoPtr< OFstream > momentBinFilePtr_
 
autoPtr< OFstream > localForceFilePtr_
 
autoPtr< OFstream > localMomentFilePtr_
 
autoPtr< OFstream > localForceBinFilePtr_
 
autoPtr< OFstream > localMomentBinFilePtr_
 
coordSystem::cartesian coordSys_
 
bool writeFields_
 

Detailed Description

Definition at line 49 of file ITHACAforces18.H.

Member Enumeration Documentation

◆ fileID

enum Foam::functionObjects::ITHACAforces::fileID
protected
Enumerator
MAIN_FILE 
BINS_FILE 

Definition at line 57 of file ITHACAforces.H.

Constructor & Destructor Documentation

◆ ITHACAforces() [1/6]

Foam::functionObjects::ITHACAforces::ITHACAforces ( const ITHACAforces & )
protected

◆ ITHACAforces() [2/6]

Foam::functionObjects::ITHACAforces::ITHACAforces ( const word & name,
const Time & runTime,
const dictionary & dict )

Definition at line 1568 of file ITHACAforces.C.

◆ ITHACAforces() [3/6]

Foam::functionObjects::ITHACAforces::ITHACAforces ( const word & name,
const objectRegistry & obr,
const dictionary & dict )

Definition at line 1603 of file ITHACAforces.C.

◆ ~ITHACAforces() [1/2]

Foam::functionObjects::ITHACAforces::~ITHACAforces ( )
virtual

Definition at line 1640 of file ITHACAforces.C.

◆ ITHACAforces() [4/6]

Foam::functionObjects::ITHACAforces::ITHACAforces ( const ITHACAforces & )
protecteddelete

◆ ITHACAforces() [5/6]

Foam::functionObjects::ITHACAforces::ITHACAforces ( const word & name,
const Time & runTime,
const dictionary & dict,
const bool readFields = true )

◆ ITHACAforces() [6/6]

Foam::functionObjects::ITHACAforces::ITHACAforces ( const word & name,
const objectRegistry & obr,
const dictionary & dict,
const bool readFields = true )

◆ ~ITHACAforces() [2/2]

virtual Foam::functionObjects::ITHACAforces::~ITHACAforces ( )
virtual

Member Function Documentation

◆ addToFields() [1/2]

void Foam::functionObjects::ITHACAforces::addToFields ( const label patchi,
const vectorField & Md,
const vectorField & fN,
const vectorField & fT,
const vectorField & fP )
protected

◆ addToFields() [2/2]

void Foam::functionObjects::ITHACAforces::addToFields ( const labelList & cellIDs,
const vectorField & Md,
const vectorField & fN,
const vectorField & fT,
const vectorField & fP )
protected

◆ applyBins() [1/2]

void Foam::functionObjects::ITHACAforces::applyBins ( const vectorField & Md,
const vectorField & fN,
const vectorField & fT,
const vectorField & fP,
const vectorField & d )
protected

Definition at line 1411 of file ITHACAforces.C.

◆ applyBins() [2/2]

void Foam::functionObjects::ITHACAforces::applyBins ( const vectorField & Md,
const vectorField & fN,
const vectorField & fT,
const vectorField & fP,
const vectorField & d )
protected

◆ calcForcesMoment() [1/2]

void Foam::functionObjects::ITHACAforces::calcForcesMoment ( )
virtual

Definition at line 1770 of file ITHACAforces.C.

◆ calcForcesMoment() [2/2]

virtual void Foam::functionObjects::ITHACAforces::calcForcesMoment ( )
virtual

◆ createFileNames()

Foam::wordList Foam::functionObjects::ITHACAforces::createFileNames ( const dictionary & dict) const
protected

Definition at line 1110 of file ITHACAforces.C.

◆ createFiles()

void Foam::functionObjects::ITHACAforces::createFiles ( )
protected

◆ devRhoReff() [1/2]

Foam::tmp< Foam::volSymmTensorField > Foam::functionObjects::ITHACAforces::devRhoReff ( ) const
protected

Definition at line 1273 of file ITHACAforces.C.

◆ devRhoReff() [2/2]

tmp< volSymmTensorField > Foam::functionObjects::ITHACAforces::devRhoReff ( ) const
protected

◆ execute() [1/2]

bool Foam::functionObjects::ITHACAforces::execute ( )
virtual

Definition at line 1889 of file ITHACAforces.C.

◆ execute() [2/2]

virtual bool Foam::functionObjects::ITHACAforces::execute ( )
virtual

◆ fieldName()

word Foam::functionObjects::ITHACAforces::fieldName ( const word & name) const
protected

◆ forceEff() [1/2]

Foam::vector Foam::functionObjects::ITHACAforces::forceEff ( ) const
virtual

Definition at line 1877 of file ITHACAforces.C.

◆ forceEff() [2/2]

virtual vector Foam::functionObjects::ITHACAforces::forceEff ( ) const
virtual

◆ forcePorous()

Foam::vector Foam::functionObjects::ITHACAforces::forcePorous ( ) const
virtual

Definition at line 1894 of file ITHACAforces.C.

◆ forcePressure() [1/2]

Foam::vector Foam::functionObjects::ITHACAforces::forcePressure ( ) const
virtual

Definition at line 1899 of file ITHACAforces.C.

◆ forcePressure() [2/2]

virtual vector Foam::functionObjects::ITHACAforces::forcePressure ( ) const
virtual

◆ forceTau() [1/2]

Foam::vector Foam::functionObjects::ITHACAforces::forceTau ( ) const
virtual

Definition at line 1904 of file ITHACAforces.C.

◆ forceTau() [2/2]

virtual vector Foam::functionObjects::ITHACAforces::forceTau ( ) const
virtual

◆ initialise() [1/2]

void Foam::functionObjects::ITHACAforces::initialise ( )
protected

Definition at line 1227 of file ITHACAforces.C.

◆ initialise() [2/2]

void Foam::functionObjects::ITHACAforces::initialise ( )
protected

◆ initialiseBins()

void Foam::functionObjects::ITHACAforces::initialiseBins ( )
protected

◆ momentEff() [1/2]

Foam::vector Foam::functionObjects::ITHACAforces::momentEff ( ) const
virtual

Definition at line 1883 of file ITHACAforces.C.

◆ momentEff() [2/2]

virtual vector Foam::functionObjects::ITHACAforces::momentEff ( ) const
virtual

◆ mu() [1/2]

Foam::tmp< Foam::volScalarField > Foam::functionObjects::ITHACAforces::mu ( ) const
protected

Definition at line 1325 of file ITHACAforces.C.

◆ mu() [2/2]

tmp< volScalarField > Foam::functionObjects::ITHACAforces::mu ( ) const
protected

◆ operator=() [1/2]

void Foam::functionObjects::ITHACAforces::operator= ( const ITHACAforces & )
protected

◆ operator=() [2/2]

void Foam::functionObjects::ITHACAforces::operator= ( const ITHACAforces & )
protecteddelete

◆ read() [1/2]

bool Foam::functionObjects::ITHACAforces::read ( const dictionary & dict)
virtual

Definition at line 1646 of file ITHACAforces.C.

◆ read() [2/2]

virtual bool Foam::functionObjects::ITHACAforces::read ( const dictionary & )
virtual

◆ resetFields()

void Foam::functionObjects::ITHACAforces::resetFields ( )
protected

◆ rho() [1/4]

Foam::tmp< Foam::volScalarField > Foam::functionObjects::ITHACAforces::rho ( ) const
protected

Definition at line 1364 of file ITHACAforces.C.

◆ rho() [2/4]

tmp< volScalarField > Foam::functionObjects::ITHACAforces::rho ( ) const
protected

◆ rho() [3/4]

Foam::scalar Foam::functionObjects::ITHACAforces::rho ( const volScalarField & p) const
protected

Definition at line 1390 of file ITHACAforces.C.

◆ rho() [4/4]

scalar Foam::functionObjects::ITHACAforces::rho ( const volScalarField & p) const
protected

◆ TypeName() [1/2]

Foam::functionObjects::ITHACAforces::TypeName ( "ITHACAforces" )

◆ TypeName() [2/2]

Foam::functionObjects::ITHACAforces::TypeName ( "ITHACAforces" )

◆ write() [1/2]

bool Foam::functionObjects::ITHACAforces::write ( )
virtual

Definition at line 1910 of file ITHACAforces.C.

◆ write() [2/2]

virtual bool Foam::functionObjects::ITHACAforces::write ( )
virtual

◆ writeBinHeader()

void Foam::functionObjects::ITHACAforces::writeBinHeader ( const word & header,
Ostream & os ) const
protected

◆ writeBinnedForceMoment()

void Foam::functionObjects::ITHACAforces::writeBinnedForceMoment ( const List< Field< vector > > & fm,
autoPtr< OFstream > & osPtr ) const
protected

◆ writeBins() [1/2]

void Foam::functionObjects::ITHACAforces::writeBins ( )
protected

Definition at line 1489 of file ITHACAforces.C.

◆ writeBins() [2/2]

void Foam::functionObjects::ITHACAforces::writeBins ( )
protected

◆ writeFileHeader()

void Foam::functionObjects::ITHACAforces::writeFileHeader ( const label i)
protectedvirtual

Definition at line 1136 of file ITHACAforces.C.

◆ writeForces() [1/2]

void Foam::functionObjects::ITHACAforces::writeForces ( )
protected

Definition at line 1446 of file ITHACAforces.C.

◆ writeForces() [2/2]

void Foam::functionObjects::ITHACAforces::writeForces ( )
protected

◆ writeIntegratedForceMoment()

void Foam::functionObjects::ITHACAforces::writeIntegratedForceMoment ( const string & descriptor,
const vectorField & fm0,
const vectorField & fm1,
const vectorField & fm2,
autoPtr< OFstream > & osPtr ) const
protected

◆ writeIntegratedHeader()

void Foam::functionObjects::ITHACAforces::writeIntegratedHeader ( const word & header,
Ostream & os ) const
protected

Member Data Documentation

◆ binCumulative_

bool Foam::functionObjects::ITHACAforces::binCumulative_
protected

Definition at line 124 of file ITHACAforces.H.

◆ binDir_

vector Foam::functionObjects::ITHACAforces::binDir_
protected

Definition at line 112 of file ITHACAforces.H.

◆ binDx_

scalar Foam::functionObjects::ITHACAforces::binDx_
protected

Definition at line 115 of file ITHACAforces.H.

◆ binMin_

scalar Foam::functionObjects::ITHACAforces::binMin_
protected

Definition at line 118 of file ITHACAforces.H.

◆ binPoints_

List< point > Foam::functionObjects::ITHACAforces::binPoints_
protected

Definition at line 121 of file ITHACAforces.H.

◆ coordSys_ [1/2]

coordinateSystem Foam::functionObjects::ITHACAforces::coordSys_
protected

Definition at line 97 of file ITHACAforces.H.

◆ coordSys_ [2/2]

coordSystem::cartesian Foam::functionObjects::ITHACAforces::coordSys_
protected

Definition at line 119 of file ITHACAforces18.H.

◆ directForceDensity_

Switch Foam::functionObjects::ITHACAforces::directForceDensity_
protected

Definition at line 85 of file ITHACAforces.H.

◆ fDName_

word Foam::functionObjects::ITHACAforces::fDName_
protected

Definition at line 88 of file ITHACAforces.H.

◆ force_

List< Field< vector > > Foam::functionObjects::ITHACAforces::force_
protected

Definition at line 64 of file ITHACAforces.H.

◆ forceBinFilePtr_

autoPtr<OFstream> Foam::functionObjects::ITHACAforces::forceBinFilePtr_
protected

Definition at line 74 of file ITHACAforces18.H.

◆ forceFilePtr_

autoPtr<OFstream> Foam::functionObjects::ITHACAforces::forceFilePtr_
protected

Definition at line 68 of file ITHACAforces18.H.

◆ initialised_

bool Foam::functionObjects::ITHACAforces::initialised_
protected

Definition at line 128 of file ITHACAforces.H.

◆ localForceBinFilePtr_

autoPtr<OFstream> Foam::functionObjects::ITHACAforces::localForceBinFilePtr_
protected

Definition at line 86 of file ITHACAforces18.H.

◆ localForceFilePtr_

autoPtr<OFstream> Foam::functionObjects::ITHACAforces::localForceFilePtr_
protected

Definition at line 80 of file ITHACAforces18.H.

◆ localMomentBinFilePtr_

autoPtr<OFstream> Foam::functionObjects::ITHACAforces::localMomentBinFilePtr_
protected

Definition at line 89 of file ITHACAforces18.H.

◆ localMomentFilePtr_

autoPtr<OFstream> Foam::functionObjects::ITHACAforces::localMomentFilePtr_
protected

Definition at line 83 of file ITHACAforces18.H.

◆ localSystem_

bool Foam::functionObjects::ITHACAforces::localSystem_
protected

Definition at line 100 of file ITHACAforces.H.

◆ moment_

List< Field< vector > > Foam::functionObjects::ITHACAforces::moment_
protected

Definition at line 67 of file ITHACAforces.H.

◆ momentBinFilePtr_

autoPtr<OFstream> Foam::functionObjects::ITHACAforces::momentBinFilePtr_
protected

Definition at line 77 of file ITHACAforces18.H.

◆ momentFilePtr_

autoPtr<OFstream> Foam::functionObjects::ITHACAforces::momentFilePtr_
protected

Definition at line 71 of file ITHACAforces18.H.

◆ nBin_

label Foam::functionObjects::ITHACAforces::nBin_
protected

Definition at line 109 of file ITHACAforces.H.

◆ patchSet_

labelHashSet Foam::functionObjects::ITHACAforces::patchSet_
protected

Definition at line 73 of file ITHACAforces.H.

◆ pName_

word Foam::functionObjects::ITHACAforces::pName_
protected

Definition at line 76 of file ITHACAforces.H.

◆ porosity_

bool Foam::functionObjects::ITHACAforces::porosity_
protected

Definition at line 103 of file ITHACAforces.H.

◆ pRef_

scalar Foam::functionObjects::ITHACAforces::pRef_
protected

Definition at line 94 of file ITHACAforces.H.

◆ rhoName_

word Foam::functionObjects::ITHACAforces::rhoName_
protected

Definition at line 82 of file ITHACAforces.H.

◆ rhoRef_

scalar Foam::functionObjects::ITHACAforces::rhoRef_
protected

Definition at line 91 of file ITHACAforces.H.

◆ UName_

word Foam::functionObjects::ITHACAforces::UName_
protected

Definition at line 79 of file ITHACAforces.H.

◆ writeFields_

bool Foam::functionObjects::ITHACAforces::writeFields_
protected

Definition at line 150 of file ITHACAforces18.H.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.11.0