Solver of the adjoint to the eikonal PDE. More...

Collaboration diagram for adjointEikonalSolver:

[legend]

Public Member Functions
	TypeName ("adjointEikonalSolver")

	adjointEikonalSolver (const fvMesh &mesh, const dictionary &dict, const autoPtr< incompressible::RASModelVariables > &RASModelVars, incompressibleAdjointVars &adjointVars, const labelHashSet &sensitivityPatchIDs)

virtual	~adjointEikonalSolver ()=default

virtual bool	readDict (const dictionary &dict)

void	accumulateIntegrand (const scalar dt)

void	solve ()

void	reset ()

boundaryVectorField &	distanceSensitivities ()

tmp< volTensorField >	getFISensitivityTerm () const

const volScalarField &	da ()

const volScalarField &	d ()

tmp< volVectorField >	gradEikonal ()

Protected Member Functions
wordList	patchTypes () const

tmp< surfaceScalarField >	computeYPhi ()

void	read ()

Protected Attributes
const fvMesh &	mesh_

dictionary	dict_

const autoPtr< incompressible::RASModelVariables > &	RASModelVars_

autoPtr< Foam::incompressibleAdjoint::adjointRASModel > &	adjointTurbulence_

const labelHashSet &	sensitivityPatchIDs_

label	nEikonalIters_

scalar	tolerance_

scalar	epsilon_

labelHashSet	wallPatchIDs_

volScalarField	da_

volScalarField	source_

autoPtr< boundaryVectorField >	distanceSensPtr_

Detailed Description

Solver of the adjoint to the eikonal PDE.

Reference:

    For the development of the adjoint eikonal PDE and its boundary
    conditions

        Papoutsis-Kiachagias, E. M., & Giannakoglou, K. C. (2014).
        Continuous Adjoint Methods for Turbulent Flows, Applied to Shape
        and Topology Optimization: Industrial Applications.
        Archives of Computational Methods in Engineering, 23(2), 255-299.
        http://doi.org/10.1007/s11831-014-9141-9

To be as consistent as possible, it is recommended to use the advectionDiffusion wallDist method in fvSchemes, instead of the more widely used meshWave

Example of the adjointEikonalSolver specification in optimisationDict:

    optimisation
    {
        sensitivities
        {
            includeDistance true;
            adjointEikonalSolver
            {
                // epsilon should be the same as the one used
                // in fvSchemes/wallDist/advectionDiffusionCoeffs
                epsilon   0.1;
                iters     1000;
                tolerance 1e-6;
            }
        }
    }

Example of the entries in fvSchemes:

    divSchemes
    {
        .
        .
        // avoid bounded schemes since yPhi is not conservative
        div(-yPhi,da) Gauss linearUpwind grad(da);
        .
        .
    }
    laplacianSchemes
    {
        .
        .
        laplacian(yWall,da) Gauss linear corrected;
        .
        .
    }

Also, the solver specification and a relaxation factor for da are required in fvSolution

    da
    {
        solver          PBiCGStab;
        preconditioner  DILU;
        tolerance       1e-9;
        relTol          0.1;
    }

    relaxationFactors
    {
        equations
        {
            .
            .
            da           0.5;
            .
            .
        }
    }

See also: Foam::patchDistMethod::advectionDiffusion Foam::wallDist

Source files

Definition at line 142 of file adjointEikonalSolverIncompressible.H.

Constructor & Destructor Documentation

◆ adjointEikonalSolver()

adjointEikonalSolver	(	const fvMesh &	mesh,
		const dictionary &	dict,
		const autoPtr< incompressible::RASModelVariables > &	RASModelVars,
		incompressibleAdjointVars &	adjointVars,
		const labelHashSet &	sensitivityPatchIDs
	)

Definition at line 106 of file adjointEikonalSolverIncompressible.C.

References Foam::read().

Here is the call graph for this function:

◆ ~adjointEikonalSolver()

virtual ~adjointEikonalSolver ( )

virtualdefault

Member Function Documentation

◆ patchTypes()

wordList patchTypes ( ) const

protected

Definition at line 41 of file adjointEikonalSolverIncompressible.C.

References fvMesh::boundary(), adjointEikonalSolver::mesh_, and adjointEikonalSolver::wallPatchIDs_.

Here is the call graph for this function:

◆ computeYPhi()

tmp< surfaceScalarField > computeYPhi ( )

protected

Definition at line 66 of file adjointEikonalSolverIncompressible.C.

References fvMesh::boundary(), GeometricField::boundaryFieldRef(), adjointEikonalSolver::d(), Foam::dimless, Foam::fvc::grad(), Foam::fvc::interpolate(), adjointEikonalSolver::mesh_, tmp::New(), IOobject::NO_READ, IOobject::NO_WRITE, patches, adjointEikonalSolver::RASModelVars_, fvMesh::Sf(), fvMesh::time(), Time::timeName(), adjointEikonalSolver::wallPatchIDs_, and Foam::Zero.

Referenced by adjointEikonalSolver::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

void read ( )

protected

Definition at line 58 of file adjointEikonalSolverIncompressible.C.

References adjointEikonalSolver::dict_, Foam::constant::electromagnetic::e, adjointEikonalSolver::epsilon_, dictionary::getOrDefault(), adjointEikonalSolver::nEikonalIters_, and adjointEikonalSolver::tolerance_.

Referenced by adjointEikonalSolver::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "adjointEikonalSolver" )

◆ readDict()

bool readDict ( const dictionary & dict )

virtual

Definition at line 163 of file adjointEikonalSolverIncompressible.C.

References dict, and adjointEikonalSolver::dict_.

◆ accumulateIntegrand()

void accumulateIntegrand ( const scalar dt )

Definition at line 171 of file adjointEikonalSolverIncompressible.C.

References adjointEikonalSolver::adjointTurbulence_, and adjointEikonalSolver::source_.

◆ solve()

void solve ( )

◆ reset()

void reset ( )

Definition at line 225 of file adjointEikonalSolverIncompressible.C.

References adjointEikonalSolver::distanceSensPtr_, adjointEikonalSolver::source_, VectorSpace< Vector< scalar >, scalar, 3 >::zero, and Foam::Zero.

◆ distanceSensitivities()

boundaryVectorField & distanceSensitivities ( )

Definition at line 232 of file adjointEikonalSolverIncompressible.C.

References fvMesh::boundary(), GeometricField::boundaryField(), adjointEikonalSolver::d(), adjointEikonalSolver::da_, adjointEikonalSolver::distanceSensPtr_, Foam::endl(), Foam::Info, adjointEikonalSolver::mesh_, adjointEikonalSolver::RASModelVars_, and adjointEikonalSolver::sensitivityPatchIDs_.

Here is the call graph for this function:

◆ getFISensitivityTerm()

tmp< volTensorField > getFISensitivityTerm ( ) const

Definition at line 253 of file adjointEikonalSolverIncompressible.C.

References IOobject::AUTO_WRITE, adjointEikonalSolver::d(), adjointEikonalSolver::da_, Foam::dimLength, Foam::endl(), adjointEikonalSolver::epsilon_, Foam::fvc::grad(), Foam::Info, adjointEikonalSolver::mesh_, IOobject::NO_READ, adjointEikonalSolver::RASModelVars_, tmp::ref(), fvMesh::time(), Time::timeName(), adjointEikonalSolver::wallPatchIDs_, and Foam::Zero.

Here is the call graph for this function:

◆ da()

const volScalarField & da ( )

Definition at line 303 of file adjointEikonalSolverIncompressible.C.

References adjointEikonalSolver::da_.

◆ d()

const volScalarField& d ( )

Referenced by adjointEikonalSolver::computeYPhi(), adjointEikonalSolver::distanceSensitivities(), adjointEikonalSolver::getFISensitivityTerm(), adjointEikonalSolver::gradEikonal(), and adjointEikonalSolver::solve().

Here is the caller graph for this function:

◆ gradEikonal()

tmp< volVectorField > gradEikonal ( )

Definition at line 309 of file adjointEikonalSolverIncompressible.C.

References adjointEikonalSolver::d(), Foam::fvc::grad(), tmp::New(), and adjointEikonalSolver::RASModelVars_.

Here is the call graph for this function:

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

Definition at line 159 of file adjointEikonalSolverIncompressible.H.

Referenced by adjointEikonalSolver::computeYPhi(), adjointEikonalSolver::distanceSensitivities(), adjointEikonalSolver::getFISensitivityTerm(), adjointEikonalSolver::patchTypes(), and adjointEikonalSolver::solve().

◆ dict_

dictionary dict_

protected

Definition at line 161 of file adjointEikonalSolverIncompressible.H.

Referenced by adjointEikonalSolver::read(), and adjointEikonalSolver::readDict().

◆ RASModelVars_

const autoPtr<incompressible::RASModelVariables>& RASModelVars_

protected

Definition at line 163 of file adjointEikonalSolverIncompressible.H.

Referenced by adjointEikonalSolver::computeYPhi(), adjointEikonalSolver::distanceSensitivities(), adjointEikonalSolver::getFISensitivityTerm(), adjointEikonalSolver::gradEikonal(), and adjointEikonalSolver::solve().

◆ adjointTurbulence_

autoPtr<Foam::incompressibleAdjoint::adjointRASModel>& adjointTurbulence_

protected

Definition at line 166 of file adjointEikonalSolverIncompressible.H.

Referenced by adjointEikonalSolver::accumulateIntegrand().

◆ sensitivityPatchIDs_

const labelHashSet& sensitivityPatchIDs_

protected

Definition at line 168 of file adjointEikonalSolverIncompressible.H.

Referenced by adjointEikonalSolver::distanceSensitivities().

◆ nEikonalIters_

label nEikonalIters_

protected

Definition at line 170 of file adjointEikonalSolverIncompressible.H.

Referenced by adjointEikonalSolver::read(), and adjointEikonalSolver::solve().

◆ tolerance_

scalar tolerance_

protected

Definition at line 172 of file adjointEikonalSolverIncompressible.H.

Referenced by adjointEikonalSolver::read(), and adjointEikonalSolver::solve().

◆ epsilon_

scalar epsilon_

protected

Definition at line 174 of file adjointEikonalSolverIncompressible.H.

Referenced by adjointEikonalSolver::getFISensitivityTerm(), adjointEikonalSolver::read(), and adjointEikonalSolver::solve().

◆ wallPatchIDs_

labelHashSet wallPatchIDs_

protected

Definition at line 176 of file adjointEikonalSolverIncompressible.H.

Referenced by adjointEikonalSolver::computeYPhi(), adjointEikonalSolver::getFISensitivityTerm(), and adjointEikonalSolver::patchTypes().

◆ da_

volScalarField da_

protected

Definition at line 178 of file adjointEikonalSolverIncompressible.H.

Referenced by adjointEikonalSolver::da(), adjointEikonalSolver::distanceSensitivities(), adjointEikonalSolver::getFISensitivityTerm(), and adjointEikonalSolver::solve().

◆ source_

volScalarField source_

protected

Definition at line 180 of file adjointEikonalSolverIncompressible.H.

Referenced by adjointEikonalSolver::accumulateIntegrand(), adjointEikonalSolver::reset(), and adjointEikonalSolver::solve().

◆ distanceSensPtr_

autoPtr<boundaryVectorField> distanceSensPtr_

protected

Definition at line 183 of file adjointEikonalSolverIncompressible.H.

Referenced by adjointEikonalSolver::distanceSensitivities(), and adjointEikonalSolver::reset().

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

src/optimisation/adjointOptimisation/adjoint/optimisation/adjointSensitivity/incompressible/adjointEikonalSolver/adjointEikonalSolverIncompressible.H
src/optimisation/adjointOptimisation/adjoint/optimisation/adjointSensitivity/incompressible/adjointEikonalSolver/adjointEikonalSolverIncompressible.C

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ adjointEikonalSolver()

◆ ~adjointEikonalSolver()

Member Function Documentation

◆ patchTypes()

◆ computeYPhi()

◆ read()

◆ TypeName()

◆ readDict()

◆ accumulateIntegrand()

◆ solve()

◆ reset()

◆ distanceSensitivities()

◆ getFISensitivityTerm()

◆ da()

◆ d()

◆ gradEikonal()

Member Data Documentation

◆ mesh_

◆ dict_

◆ RASModelVars_

◆ adjointTurbulence_

◆ sensitivityPatchIDs_

◆ nEikonalIters_

◆ tolerance_

◆ epsilon_

◆ wallPatchIDs_

◆ da_

◆ source_

◆ distanceSensPtr_