rigidBodyPropellerDisk force restraint. More...

Inheritance diagram for propellerDiskForce:

Collaboration diagram for propellerDiskForce:

Public Member Functions
	TypeName ("propellerDiskForce")
	Runtime type information. More...

	propellerDiskForce (const word &name, const dictionary &dict, const rigidBodyModel &model)
	Construct from components. More...

virtual autoPtr< restraint >	clone () const
	Construct and return a clone. More...

virtual	~propellerDiskForce ()
	Destructor. More...

virtual void	restrain (scalarField &tau, Field< spatialVector > &fx, const rigidBodyModelState &state) const
	Accumulate the retraint internal joint forces into the tau field and. More...

virtual bool	read (const dictionary &dict)
	Update properties from given dictionary. More...

virtual void	write (Ostream &) const
	Write. More...

Public Member Functions inherited from restraint
	TypeName ("restraint")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, restraint, dictionary,(const word &name, const dictionary &dict, const rigidBodyModel &model),(name, dict, model))

	restraint (const word &name, const dictionary &dict, const rigidBodyModel &model)
	Construct from the dict dictionary and Time. More...

virtual	~restraint ()
	Destructor. More...

const word &	name () const
	Return the name. More...

label	bodyIndex () const

const dictionary &	coeffDict () const
	Return access to coeffs. More...

Additional Inherited Members
Static Public Member Functions inherited from restraint
static autoPtr< restraint >	New (const word &name, const dictionary &dict, const rigidBodyModel &model)
	Select constructed from the dict dictionary and Time. More...

Protected Member Functions inherited from restraint
point	bodyPoint (const point &p) const
	Transform the given point on the restrained body to the global frame. More...

spatialVector	bodyPointVelocity (const point &p) const
	Transform the velocity of the given point on the restrained body. More...

Protected Attributes inherited from restraint
word	name_
	Name of the restraint. More...

label	bodyIndex_
	Index of the body the restraint is applied to. More...

label	masterBodyIndex_
	Index of the master body the restraint is applied to. More...

dictionary	coeffs_
	Restraint model specific coefficient dictionary. More...

const rigidBodyModel &	model_
	Reference to the model. More...

Detailed Description

rigidBodyPropellerDisk force restraint.

Applies the opposite force and moment of the propellerDisk onto the body the propeller is attached to.

Usage

Example applying the propeller force and moment to the floatingObject:

restraints
{
    force
    {
        type        propellerDiskForce;
        body        floatingObject;
    }
}

See also: Foam::fv::rigidBodyPropellerDisk Foam::fv::propellerDisk

Source files

Definition at line 73 of file propellerDiskForce.H.

Constructor & Destructor Documentation

◆ propellerDiskForce()

propellerDiskForce	(	const word &	name,
		const dictionary &	dict,
		const rigidBodyModel &	model
	)

Construct from components.

Definition at line 55 of file propellerDiskForce.C.

References dict, and propellerDiskForce::read().

Referenced by propellerDiskForce::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~propellerDiskForce()

~propellerDiskForce ( )

virtual

Destructor.

Definition at line 70 of file propellerDiskForce.C.

Member Function Documentation

◆ TypeName()

TypeName ( "propellerDiskForce" )

Runtime type information.

◆ clone()

virtual autoPtr<restraint> clone ( ) const

inlinevirtual

Construct and return a clone.

Implements restraint.

Definition at line 95 of file propellerDiskForce.H.

References propellerDiskForce::propellerDiskForce().

Here is the call graph for this function:

◆ restrain()

void restrain	(	scalarField &	tau,
		Field< spatialVector > &	fx,
		const rigidBodyModelState &	state
	)		const

virtual

Accumulate the retraint internal joint forces into the tau field and.

external forces into the fx field

Implements restraint.

Definition at line 76 of file propellerDiskForce.C.

References rigidBodyPropellerDisk::bodyID(), rigidBodyPropellerDisk::centre(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, propellerDisk::force(), fvModels(), Foam::Info, motionSolver::mesh(), mesh, propellerDisk::moment(), and dictionary::New().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Update properties from given dictionary.

Reimplemented from restraint.

Definition at line 140 of file propellerDiskForce.C.

References dict, and restraint::read().

Referenced by propellerDiskForce::propellerDiskForce().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Implements restraint.

Definition at line 151 of file propellerDiskForce.C.

References restraint::write().

Here is the call graph for this function:

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

src/fvModels/rigidBodyPropellerDisk/propellerDiskForce/propellerDiskForce.H
src/fvModels/rigidBodyPropellerDisk/propellerDiskForce/propellerDiskForce.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ propellerDiskForce()

◆ ~propellerDiskForce()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ restrain()

◆ read()

◆ write()